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

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

All Implemented Interfaces:

GPTool

public class ExtractMultiValuesToPoints
extends AbstractGPTool

Extracts cell values at locations specified in a point feature class from one or more rasters, and records the values to the attribute table of the point feature class. The Extract Multi Values to Points tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Any combination of rasters (single band or multiband) can be specified as input.
• A cell value will be extracted for each input raster and a new field containing the cell values for each input raster are appended to the input point feature class.
• Output field names are created from the name of the input raster by default. Otherwise you can specify a unique name for each field to store raster values.
• When the input is a multiband raster, a field will be added for all bands with a "b1_, b2_, …bn" prefix added to the name of the output field denoting the band number.
• 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.
• Shapefile formats have a field limitation of maximum 10 characters in length. Output fields appended to input shapefile will be truncated and made unique by default. This may make it hard to distinguish between input rasters if the names are long or very similar. In this case it is suggested to convert the features to a file geodatabase.
• NoData cells in the value raster will be given a NULL Value. For shapefiles, NULL is not supported and a value of 0 (zero) will be given.

Field Summary

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

vals

Constructor Summary

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

ExtractMultiValuesToPoints(Object inPointFeatures, Object inRasters)
Creates the Extract Multi Values to Points tool with the required parameters.

Method Summary

String	getBilinearInterpolateValues() Returns the Bilinear interpolation of values at point locations parameter of this tool .
Object	getInPointFeatures() Returns the Input point features parameter of this tool .
Object	getInRasters() Returns the Input rasters parameter of this tool .
Object	getOutPointFeatures() Returns the Output point features parameter of this tool (Read only).
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	setBilinearInterpolateValues(String bilinearInterpolateValues) Sets the Bilinear interpolation of values at point locations parameter of this tool .
void	setInPointFeatures(Object inPointFeatures) Sets the Input point features parameter of this tool .
void	setInRasters(Object inRasters) Sets the Input rasters 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

ExtractMultiValuesToPoints

public ExtractMultiValuesToPoints()

Creates the Extract Multi Values to Points tool with defaults.

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

ExtractMultiValuesToPoints

public ExtractMultiValuesToPoints(Object inPointFeatures,
                                  Object inRasters)

Creates the Extract Multi 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 to which you want to add raster values.

inRasters - the input raster (or rasters) values you want to extract based on the input point feature location. optionally, you can supply the name for the field to store the raster value. By default, a unique field name will be created based on the input raster dataset name.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input point features parameter of this tool . This parameter is the input point features to which you want to add raster 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 to which you want to add raster values. This is a required parameter.

Parameters:

inPointFeatures - the input point features to which you want to add raster values.

getInRasters

public Object getInRasters()

Returns the Input rasters parameter of this tool . This parameter is the input raster (or rasters) values you want to extract based on the input point feature location. optionally, you can supply the name for the field to store the raster value. By default, a unique field name will be created based on the input raster dataset name. This is a required parameter.

Returns:

the Input rasters

setInRasters

public void setInRasters(Object inRasters)

Sets the Input rasters parameter of this tool . This parameter is the input raster (or rasters) values you want to extract based on the input point feature location. optionally, you can supply the name for the field to store the raster value. By default, a unique field name will be created based on the input raster dataset name. This is a required parameter.

Parameters:

inRasters - the input raster (or rasters) values you want to extract based on the input point feature location. optionally, you can supply the name for the field to store the raster value. By default, a unique field name will be created based on the input raster dataset name.

getBilinearInterpolateValues

public String getBilinearInterpolateValues()

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

Returns:

the Bilinear interpolation of values at point locations

setBilinearInterpolateValues

public void setBilinearInterpolateValues(String bilinearInterpolateValues)

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

Parameters:

bilinearInterpolateValues - specifies whether or not interpolation will be used.

getOutPointFeatures

public Object getOutPointFeatures()

Returns the Output point features parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output point features

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