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

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

All Implemented Interfaces:

GPTool

public class Sample
extends AbstractGPTool

Creates a table that shows the values of cells from a raster, or set of rasters, for defined locations. The locations are defined by raster cells or by a set of points. The Sample tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• When the input location is a raster, the set of location cells consists of all cell that have a value of zero or greater. Cells that have NoData values are not included in the location set. A location raster can be easily created using the extraction tools.
• Locations that sample NoData cells in the input raster(s) will be given a NULL Value. For shapefiles, NULL is not supported and a value of 0 (zero) will be given.
• The values of the cells will remain integers for the rasters in input rasters that are integer, even if the Bilinear or Cubic options are selected for the resampling technique.
• The cell size and registration of the input rasters and the location raster should be the same.
• The output from the tool is a table.

Field Summary

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

vals

Constructor Summary

Sample()
Creates the Sample tool with defaults.

Sample(Object inRasters, Object inLocationData, Object outTable)
Creates the Sample tool with the required parameters.

Method Summary

Object	getInLocationData() Returns the Input location raster or point features parameter of this tool .
Object	getInRasters() Returns the Input rasters parameter of this tool .
Object	getOutTable() Returns the Output table parameter of this tool .
String	getResamplingType() Returns the Resampling technique 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	setInLocationData(Object inLocationData) Sets the Input location raster or point features parameter of this tool .
void	setInRasters(Object inRasters) Sets the Input rasters parameter of this tool .
void	setOutTable(Object outTable) Sets the Output table parameter of this tool .
void	setResamplingType(String resamplingType) Sets the Resampling technique 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

Sample

public Sample()

Creates the Sample tool with defaults.

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

Sample

public Sample(Object inRasters,
              Object inLocationData,
              Object outTable)

Creates the Sample 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:

inRasters - the list of rasters whose values will be sampled based on the input location data.

inLocationData - data identifying positions at which you want a sample taken. this can be a raster or a point feature dataset.

outTable - output table holding the sampled cell values.

Method Detail

getInRasters

public Object getInRasters()

Returns the Input rasters parameter of this tool . This parameter is the list of rasters whose values will be sampled based on the input location data. 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 list of rasters whose values will be sampled based on the input location data. This is a required parameter.

Parameters:

inRasters - the list of rasters whose values will be sampled based on the input location data.

getInLocationData

public Object getInLocationData()

Returns the Input location raster or point features parameter of this tool . This parameter is data identifying positions at which you want a sample taken. this can be a raster or a point feature dataset. This is a required parameter.

Returns:

the Input location raster or point features

setInLocationData

public void setInLocationData(Object inLocationData)

Sets the Input location raster or point features parameter of this tool . This parameter is data identifying positions at which you want a sample taken. this can be a raster or a point feature dataset. This is a required parameter.

Parameters:

inLocationData - data identifying positions at which you want a sample taken. this can be a raster or a point feature dataset.

getOutTable

public Object getOutTable()

Returns the Output table parameter of this tool . This parameter is output table holding the sampled cell values. This is a required parameter.

Returns:

the Output table

setOutTable

public void setOutTable(Object outTable)

Sets the Output table parameter of this tool . This parameter is output table holding the sampled cell values. This is a required parameter.

Parameters:

outTable - output table holding the sampled cell values.

getResamplingType

public String getResamplingType()

Returns the Resampling technique parameter of this tool . This parameter is resampling algorithm used when sampling a raster. This is an optional parameter.

Returns:

the Resampling technique

setResamplingType

public void setResamplingType(String resamplingType)

Sets the Resampling technique parameter of this tool . This parameter is resampling algorithm used when sampling a raster. This is an optional parameter.

Parameters:

resamplingType - resampling algorithm used when sampling a raster.

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