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

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

All Implemented Interfaces:

GPTool

public class Pick
extends AbstractGPTool

Assigns output values using one of a list of rasters determined by the value of an input raster. The Pick tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The value of each cell of the position raster determines which input raster (or constant value) will be used to obtain the output raster value. For example, if a cell in the position raster has a value of 1, the value from the first input in the raster list will be used for the output cell value. If the position input has a value of 2, the output value will come from the second input in the raster list, and so on.
• The order of the input list is relevant for this tool. If the order of rasters changes, the results will change.
• If a cell value in the position raster is zero or negative, the result will be NoData. If the position value is larger than the number of rasters in the list, the result will be NoData.
• Any cell with a NoData value on the position raster will receive NoData on the output raster.
• If any of the rasters in the input list is floating point, the output raster will be floating point. If they are all integer, the output raster will be integer.
• A number can be used as an input raster; however, the cell size and extent must first be set in the environment.

Field Summary

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

vals

Constructor Summary

Pick()
Creates the Pick tool with defaults.

Pick(Object inPositionRaster, Object inRastersOrConstants, Object outRaster)
Creates the Pick tool with the required parameters.

Method Summary

Object	getInPositionRaster() Returns the Input position raster parameter of this tool .
Object	getInRastersOrConstants() Returns the Input rasters or constant values parameter of this tool .
Object	getOutRaster() Returns the Output raster 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	setInPositionRaster(Object inPositionRaster) Sets the Input position raster parameter of this tool .
void	setInRastersOrConstants(Object inRastersOrConstants) Sets the Input rasters or constant values parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster 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

Pick

public Pick()

Creates the Pick tool with defaults.

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

Pick

public Pick(Object inPositionRaster,
            Object inRastersOrConstants,
            Object outRaster)

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

inPositionRaster - input raster defining the position of the raster to use for the output value. the input must be a positive integer raster.

inRastersOrConstants - the list of inputs that the output value will be selected from. the inputs can be integer or float rasters, or constant values.

outRaster - the output raster.

Method Detail

getInPositionRaster

public Object getInPositionRaster()

Returns the Input position raster parameter of this tool . This parameter is input raster defining the position of the raster to use for the output value. the input must be a positive integer raster. This is a required parameter.

Returns:

the Input position raster

setInPositionRaster

public void setInPositionRaster(Object inPositionRaster)

Sets the Input position raster parameter of this tool . This parameter is input raster defining the position of the raster to use for the output value. the input must be a positive integer raster. This is a required parameter.

Parameters:

inPositionRaster - input raster defining the position of the raster to use for the output value. the input must be a positive integer raster.

getInRastersOrConstants

public Object getInRastersOrConstants()

Returns the Input rasters or constant values parameter of this tool . This parameter is the list of inputs that the output value will be selected from. the inputs can be integer or float rasters, or constant values. This is a required parameter.

Returns:

the Input rasters or constant values

setInRastersOrConstants

public void setInRastersOrConstants(Object inRastersOrConstants)

Sets the Input rasters or constant values parameter of this tool . This parameter is the list of inputs that the output value will be selected from. the inputs can be integer or float rasters, or constant values. This is a required parameter.

Parameters:

inRastersOrConstants - the list of inputs that the output value will be selected from. the inputs can be integer or float rasters, or constant values.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output raster. This is a required parameter.

Parameters:

outRaster - the output 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