com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools
Class ExtractValuesToTable

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools.ExtractValuesToTable

All Implemented Interfaces:

GPTool

public class ExtractValuesToTable
extends AbstractGPTool

Extracts cell values from a set of rasters to a table, based on a point or polygon feature class. The Extract Values To Table tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• This tool is primarily designed to analyse the output from .
• All the rasters must have the same spatial reference and cell size.
• If a point feature class is used, the output table has a record for each point and each raster that has data. Polygonal data will be treated as point data, the cell center of the input rasters will determine the number of points and will also be used to decide whether the "cell" is contained within the polygon or not.
• Values outside the raster's extent will be ignored.
• Multipart feature classes are not supported.
• In the case of coincident points, the last one encountered will be used and the rest will be ignored. In the same vane, if overlapping polygons are encountered only one of the intersected features will be processed.
• The tool can also be used, however, the output table needs to be transposed if the values are to be graphed.

Field Summary

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

vals

Constructor Summary

ExtractValuesToTable()
Creates the Extract Values To Table tool with defaults.

ExtractValuesToTable(Object inFeatures, Object inRasters, Object outTable)
Creates the Extract Values To Table tool with the required parameters.

Method Summary

String	getAddWarningField() Returns the Add warnings to output table parameter of this tool .
Object	getInFeatures() Returns the Input feature class parameter of this tool .
Object	getInRasters() Returns the Input rasters parameter of this tool .
Object	getOutTable() Returns the Output table parameter of this tool .
Object	getOutTableRasterNames() Returns the Output raster names table 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	setAddWarningField(String addWarningField) Sets the Add warnings to output table parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input feature class 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	setOutTableRasterNames(Object outTableRasterNames) Sets the Output raster names table 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

ExtractValuesToTable

public ExtractValuesToTable()

Creates the Extract Values To Table tool with defaults.

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

ExtractValuesToTable

public ExtractValuesToTable(Object inFeatures,
                            Object inRasters,
                            Object outTable)

Creates the Extract Values To Table 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:

inFeatures - the points or polygon features to be created.

inRasters - the rasters must all have the same extent, coordinate system, and cell size.

outTable - the output table contains a record for each point and each raster that has data. If polygon features are input, they are converted to points which coincide with the raster cell centers.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input feature class parameter of this tool . This parameter is the points or polygon features to be created. This is a required parameter.

Returns:

the Input feature class

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input feature class parameter of this tool . This parameter is the points or polygon features to be created. This is a required parameter.

Parameters:

inFeatures - the points or polygon features to be created.

getInRasters

public Object getInRasters()

Returns the Input rasters parameter of this tool . This parameter is the rasters must all have the same extent, coordinate system, and cell size. 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 rasters must all have the same extent, coordinate system, and cell size. This is a required parameter.

Parameters:

inRasters - the rasters must all have the same extent, coordinate system, and cell size.

getOutTable

public Object getOutTable()

Returns the Output table parameter of this tool . This parameter is the output table contains a record for each point and each raster that has data. If polygon features are input, they are converted to points which coincide with the raster cell centers. 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 the output table contains a record for each point and each raster that has data. If polygon features are input, they are converted to points which coincide with the raster cell centers. This is a required parameter.

Parameters:

outTable - the output table contains a record for each point and each raster that has data. If polygon features are input, they are converted to points which coincide with the raster cell centers.

getOutTableRasterNames

public Object getOutTableRasterNames()

Returns the Output raster names table parameter of this tool . This parameter is saves the names of the Input rasters to disc. This is an optional parameter.

Returns:

the Output raster names table

setOutTableRasterNames

public void setOutTableRasterNames(Object outTableRasterNames)

Sets the Output raster names table parameter of this tool . This parameter is saves the names of the Input rasters to disc. This is an optional parameter.

Parameters:

outTableRasterNames - saves the names of the Input rasters to disc.

getAddWarningField

public String getAddWarningField()

Returns the Add warnings to output table parameter of this tool . This parameter is records if input features are partially or completely covered by the Input rasters. This is an optional parameter.

Returns:

the Add warnings to output table

setAddWarningField

public void setAddWarningField(String addWarningField)

Sets the Add warnings to output table parameter of this tool . This parameter is records if input features are partially or completely covered by the Input rasters. This is an optional parameter.

Parameters:

addWarningField - records if input features are partially or completely covered by the Input rasters.

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