com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class ExtractValuesToPoints

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.ExtractValuesToPoints

All Implemented Interfaces:

GPTool

public class ExtractValuesToPoints
extends AbstractGPTool

Extracts the cell values of a raster based on a set of point features and records the values in the attribute table of an output feature class. The Extract Values to Points tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The output shapefile will have, at a new RASTERVALU field, added to the output feature. This field cannot already exist in the input features; otherwise, an error will be produced. All fields from the input point feature class will be included in the output point feature class.
• When Extract Values to Points is used on a multiband raster, the RASTERVALU field will contain values from the last band of the input raster. To extract values from multiple rasters or a multiband raster dataset, use the tool.
• For the RASTERVALU field of the attribute table, NoData cells in the value raster will be given a value of -9999.
• The interpolation option determines how the values will be obtained from the raster. The default option is to use the value at the center of the cell being sampled. The interpolation option will use bilinear interpolation to interpolate a value for the cell center.
• If the input raster is floating-point type, the resulting output point dataset will only contain attributes from the input feature data and the value of the cell, as determined by the interpolation option.
• When adding the attributes from the input raster, if the output point feature dataset is a shapefile, there can be no fields in the input raster with a name more than 10 characters in length. If there are, these fields must be renamed before running the tool.

Field Summary

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

vals

Constructor Summary

ExtractValuesToPoints()
Creates the Extract Values to Points tool with defaults.

ExtractValuesToPoints(Object inPointFeatures, Object inRaster, Object outPointFeatures)
Creates the Extract Values to Points tool with the required parameters.

Method Summary

String	getAddAttributes() Returns the Append all the input raster attributes to the output point features parameter of this tool .
Object	getInPointFeatures() Returns the Input point features parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
String	getInterpolateValues() Returns the Interpolate values at the point locations parameter of this tool .
Object	getOutPointFeatures() Returns the Output point features 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	setAddAttributes(String addAttributes) Sets the Append all the input raster attributes to the output point features parameter of this tool .
void	setInPointFeatures(Object inPointFeatures) Sets the Input point features parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setInterpolateValues(String interpolateValues) Sets the Interpolate values at the point locations parameter of this tool .
void	setOutPointFeatures(Object outPointFeatures) Sets the Output point features 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

ExtractValuesToPoints

public ExtractValuesToPoints()

Creates the Extract Values to Points tool with defaults.

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

ExtractValuesToPoints

public ExtractValuesToPoints(Object inPointFeatures,
                             Object inRaster,
                             Object outPointFeatures)

Creates the Extract Values to Points 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:

inPointFeatures - the input point features defining the locations from which you want to extract the raster cell values.

inRaster - the raster dataset whose values will be extracted. it can be an integer or floating-point type raster.

outPointFeatures - the output point feature dataset containing the extracted raster values.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input point features parameter of this tool . This parameter is the input point features defining the locations from which you want to extract the raster cell values. This is a required parameter.

Returns:

the Input point features

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)

Sets the Input point features parameter of this tool . This parameter is the input point features defining the locations from which you want to extract the raster cell values. This is a required parameter.

Parameters:

inPointFeatures - the input point features defining the locations from which you want to extract the raster cell values.

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the raster dataset whose values will be extracted. it can be an integer or floating-point type raster. 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 raster dataset whose values will be extracted. it can be an integer or floating-point type raster. This is a required parameter.

Parameters:

inRaster - the raster dataset whose values will be extracted. it can be an integer or floating-point type raster.

getOutPointFeatures

public Object getOutPointFeatures()

Returns the Output point features parameter of this tool . This parameter is the output point feature dataset containing the extracted raster values. 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 point feature dataset containing the extracted raster values. This is a required parameter.

Parameters:

outPointFeatures - the output point feature dataset containing the extracted raster values.

getInterpolateValues

public String getInterpolateValues()

Returns the Interpolate values at the point locations parameter of this tool . This parameter is specifies whether or not interpolation will be used. This is an optional parameter.

Returns:

the Interpolate values at the point locations

setInterpolateValues

public void setInterpolateValues(String interpolateValues)

Sets the Interpolate values at the point locations parameter of this tool . This parameter is specifies whether or not interpolation will be used. This is an optional parameter.

Parameters:

interpolateValues - specifies whether or not interpolation will be used.

getAddAttributes

public String getAddAttributes()

Returns the Append all the input raster attributes to the output point features parameter of this tool . This parameter is determines if the raster attributes are written to the output point feature dataset. This is an optional parameter.

Returns:

the Append all the input raster attributes to the output point features

setAddAttributes

public void setAddAttributes(String addAttributes)

Sets the Append all the input raster attributes to the output point features parameter of this tool . This parameter is determines if the raster attributes are written to the output point feature dataset. This is an optional parameter.

Parameters:

addAttributes - determines if the raster attributes are written to the output point feature dataset.

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