com.esri.arcgis.geoprocessing.tools.conversiontools
Class RasterToPoint

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.RasterToPoint

All Implemented Interfaces:

GPTool

public class RasterToPoint
extends AbstractGPTool

Converts a raster dataset to point features. The Raster to Point tool is contained in the Conversion Tools tool box.

Usage tips:

• For each cell of the input raster dataset, a point will be created in the output feature class. The points will be positioned at the centers of cells that they represent. The NoData cells will not be transformed into points.
• The input raster can have any cell size and may be any valid raster dataset.
• The Field parameter allows you to choose which attribute field of the input raster dataset will become an attribute in the output feature class. If a field is not specified, the cell values of the input raster (the VALUE field) will become a column with the heading Grid_code in the attribute table of the output feature class.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

RasterToPoint()
Creates the Raster to Point tool with defaults.

RasterToPoint(Object inRaster, Object outPointFeatures)
Creates the Raster to Point tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutPointFeatures() Returns the Output point features parameter of this tool .
Object	getRasterField() Returns the Field parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setOutPointFeatures(Object outPointFeatures) Sets the Output point features parameter of this tool .
void	setRasterField(Object rasterField) Sets the Field parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RasterToPoint

public RasterToPoint()

Creates the Raster to Point tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

RasterToPoint

public RasterToPoint(Object inRaster,
                     Object outPointFeatures)

Creates the Raster to Point tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inRaster - the input raster dataset. the raster can be integer or floating-point type.

outPointFeatures - the output feature class that will contain the converted points.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster dataset. the raster can be integer or floating-point type. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input raster parameter of this tool . This parameter is the input raster dataset. the raster can be integer or floating-point type. This is a required parameter.

Parameters:

inRaster - the input raster dataset. the raster can be integer or floating-point type.

getOutPointFeatures

public Object getOutPointFeatures()

Returns the Output point features parameter of this tool . This parameter is the output feature class that will contain the converted points. This is a required parameter.

Returns:

the Output point features

setOutPointFeatures

public void setOutPointFeatures(Object outPointFeatures)

Sets the Output point features parameter of this tool . This parameter is the output feature class that will contain the converted points. This is a required parameter.

Parameters:

outPointFeatures - the output feature class that will contain the converted points.

getRasterField

public Object getRasterField()

Returns the Field parameter of this tool . This parameter is the field to assign values from the cells in the input raster to the points in the output dataset. it can be an integer, floating point, or string field. This is an optional parameter.

Returns:

the Field

setRasterField

public void setRasterField(Object rasterField)

Sets the Field parameter of this tool . This parameter is the field to assign values from the cells in the input raster to the points in the output dataset. it can be an integer, floating point, or string field. This is an optional parameter.

Parameters:

rasterField - the field to assign values from the cells in the input raster to the points in the output dataset. it can be an integer, floating point, or string field.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias