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

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

All Implemented Interfaces:

GPTool

public class EqualToFrequency
extends AbstractGPTool

Evaluates on a cell-by-cell basis the number of times the values in a set of rasters are equal to another raster. The Equal To Frequency tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• 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.
• The output raster is always of integer type.

Field Summary

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

vals

Constructor Summary

EqualToFrequency()
Creates the Equal To Frequency tool with defaults.

EqualToFrequency(Object inValueRaster, Object inRasters, Object outRaster)
Creates the Equal To Frequency tool with the required parameters.

Method Summary

Object	getInRasters() Returns the Input rasters parameter of this tool .
Object	getInValueRaster() Returns the Input value raster 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	setInRasters(Object inRasters) Sets the Input rasters parameter of this tool .
void	setInValueRaster(Object inValueRaster) Sets the Input value raster 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

EqualToFrequency

public EqualToFrequency()

Creates the Equal To Frequency tool with defaults.

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

EqualToFrequency

public EqualToFrequency(Object inValueRaster,
                        Object inRasters,
                        Object outRaster)

Creates the Equal To Frequency 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:

inValueRaster - for each cell location in the input value raster, the number of occurrences (frequency) where a raster in the input list has an equal value is counted.

inRasters - the list of rasters that will be compared against the value raster.

outRaster - the output raster. for each cell in the output raster, the value represents the number of times that the corresponding cells in the list of rasters are the same as the value raster.

Method Detail

getInValueRaster

public Object getInValueRaster()

Returns the Input value raster parameter of this tool . This parameter is for each cell location in the input value raster, the number of occurrences (frequency) where a raster in the input list has an equal value is counted. This is a required parameter.

Returns:

the Input value raster

setInValueRaster

public void setInValueRaster(Object inValueRaster)

Sets the Input value raster parameter of this tool . This parameter is for each cell location in the input value raster, the number of occurrences (frequency) where a raster in the input list has an equal value is counted. This is a required parameter.

Parameters:

inValueRaster - for each cell location in the input value raster, the number of occurrences (frequency) where a raster in the input list has an equal value is counted.

getInRasters

public Object getInRasters()

Returns the Input rasters parameter of this tool . This parameter is the list of rasters that will be compared against the value raster. 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 that will be compared against the value raster. This is a required parameter.

Parameters:

inRasters - the list of rasters that will be compared against the value raster.

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 value represents the number of times that the corresponding cells in the list of rasters are the same as the value 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. for each cell in the output raster, the value represents the number of times that the corresponding cells in the list of rasters are the same as the value raster. This is a required parameter.

Parameters:

outRaster - the output raster. for each cell in the output raster, the value represents the number of times that the corresponding cells in the list of rasters are the same as the value 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