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

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

All Implemented Interfaces:

GPTool

public class Rank
extends AbstractGPTool

The values from the set of input rasters are ranked on a cell-by-cell basis, and which of these gets returned is determined by the value of the rank input raster. The Rank tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• In the list of input rasters, the order is irrelevant. However, the Rank input raster must precede these.
• An arbitrary number of rasters can be specified in the input rasters list.
• If a cell location contains NoData on any of the input rasters, that location will be assigned NoData on the output.
• If the input values are the same for any cell location, regardless of the specified popularity, the output value will be the same as the input for that cell location.
• If the rank raster value is greater than the number of input rasters, each cell location on the output will be assigned NoData.
• If any of the input rasters are floating point, the output is floating point; otherwise, it is integer.

Field Summary

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

vals

Constructor Summary

Rank()
Creates the Rank tool with defaults.

Rank(Object inRankRasterOrConstant, Object inRasters, Object outRaster)
Creates the Rank tool with the required parameters.

Method Summary

Object	getInRankRasterOrConstant() Returns the Input rank raster or constant value parameter of this tool .
Object	getInRasters() Returns the Input rasters 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	setInRankRasterOrConstant(Object inRankRasterOrConstant) Sets the Input rank raster or constant value parameter of this tool .
void	setInRasters(Object inRasters) Sets the Input rasters 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

Rank

public Rank()

Creates the Rank tool with defaults.

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

Rank

public Rank(Object inRankRasterOrConstant,
            Object inRasters,
            Object outRaster)

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

inRankRasterOrConstant - the input raster that defines the rank position to be returned. a number can be used as an input; however, the cell size and extent must first be set in the environment.

inRasters - the list of input rasters. the input defines the argument list to identify the value for the rank, defined by the first argument for each cell location.

outRaster - the output raster. for each cell in the output raster, the values in the input rasters are sorted from lowest to highest, and the input rank raster's value is used to select which will be the output value.

Method Detail

getInRankRasterOrConstant

public Object getInRankRasterOrConstant()

Returns the Input rank raster or constant value parameter of this tool . This parameter is the input raster that defines the rank position to be returned. a number can be used as an input; however, the cell size and extent must first be set in the environment. This is a required parameter.

Returns:

the Input rank raster or constant value

setInRankRasterOrConstant

public void setInRankRasterOrConstant(Object inRankRasterOrConstant)

Sets the Input rank raster or constant value parameter of this tool . This parameter is the input raster that defines the rank position to be returned. a number can be used as an input; however, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRankRasterOrConstant - the input raster that defines the rank position to be returned. a number can be used as an input; however, the cell size and extent must first be set in the environment.

getInRasters

public Object getInRasters()

Returns the Input rasters parameter of this tool . This parameter is the list of input rasters. the input defines the argument list to identify the value for the rank, defined by the first argument for each cell location. 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 input rasters. the input defines the argument list to identify the value for the rank, defined by the first argument for each cell location. This is a required parameter.

Parameters:

inRasters - the list of input rasters. the input defines the argument list to identify the value for the rank, defined by the first argument for each cell location.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. for each cell in the output raster, the values in the input rasters are sorted from lowest to highest, and the input rank raster's value is used to select which will be the output value. 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. for each cell in the output raster, the values in the input rasters are sorted from lowest to highest, and the input rank raster's value is used to select which will be the output value. This is a required parameter.

Parameters:

outRaster - the output raster. for each cell in the output raster, the values in the input rasters are sorted from lowest to highest, and the input rank raster's value is used to select which will be the output value.

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