com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class GetCellValue

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.GetCellValue

All Implemented Interfaces:

GPTool

public class GetCellValue
extends AbstractGPTool

Retrieves the pixel value at a specific x,y coordinate. For multi-band raster datasets you can specify from which bands to retreive the cell value. If you do not specify any bands, the pixel value for all the bands will be returned for that location. The Get Cell Value tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• This tool is used when you need the pixel value for a geoprocessing model. In ArcMap, you can use the Identify tool instead.
• When working with multiple-band raster datasets you can get the pixel values for all the bands or simply the bands you are interested in.
• The following environments affect this tool: current workspace; and scratch workspace;

Field Summary

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

vals

Constructor Summary

GetCellValue()
Creates the Get Cell Value tool with defaults.

GetCellValue(Object inRaster, Object locationPoint)
Creates the Get Cell Value tool with the required parameters.

Method Summary

Object	getBandIndex() Returns the Bands parameter of this tool .
Object	getInRaster() Returns the Input Raster parameter of this tool .
Object	getLocationPoint() Returns the Location parameter of this tool .
String	getOutString() Returns the Output String 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	setBandIndex(Object bandIndex) Sets the Bands parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setLocationPoint(Object locationPoint) Sets the Location 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

GetCellValue

public GetCellValue()

Creates the Get Cell Value tool with defaults.

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

GetCellValue

public GetCellValue(Object inRaster,
                    Object locationPoint)

Creates the Get Cell Value 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 - Raster dataset, the input raster dataset.

locationPoint - Point, type the xy coordinates of the pixel location.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is Raster dataset, the input raster dataset. 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 Raster dataset, the input raster dataset. This is a required parameter.

Parameters:

inRaster - Raster dataset, the input raster dataset.

getLocationPoint

public Object getLocationPoint()

Returns the Location parameter of this tool . This parameter is Point, type the xy coordinates of the pixel location. This is a required parameter.

Returns:

the Location

setLocationPoint

public void setLocationPoint(Object locationPoint)

Sets the Location parameter of this tool . This parameter is Point, type the xy coordinates of the pixel location. This is a required parameter.

Parameters:

locationPoint - Point, type the xy coordinates of the pixel location.

getBandIndex

public Object getBandIndex()

Returns the Bands parameter of this tool . This parameter is Long, define which bands you would like to get the pixel value for. If you do not define any bands, the tool will return the pixel value for all the bands in the xy location. This is an optional parameter.

Returns:

the Bands

setBandIndex

public void setBandIndex(Object bandIndex)

Sets the Bands parameter of this tool . This parameter is Long, define which bands you would like to get the pixel value for. If you do not define any bands, the tool will return the pixel value for all the bands in the xy location. This is an optional parameter.

Parameters:

bandIndex - Long, define which bands you would like to get the pixel value for. If you do not define any bands, the tool will return the pixel value for all the bands in the xy location.

getOutString

public String getOutString()

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

Returns:

the Output String

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