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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.EqualToFrequency
All Implemented Interfaces:
GPTool

public class EqualToFrequency
extends AbstractGPTool

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

Software restrictions: none

Illustration:

Usage tips:


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 - Composite Geodataset, input raster defining the value that determines the number of times the set of rasters is equal to it.
inRasters - Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and its cell size will be set in the analysis environment, with each location containing the input number.
outRaster - Raster Dataset, the raster to be created.
Method Detail

getInValueRaster

public Object getInValueRaster()
Returns the Input value raster parameter of this tool . This parameter is Composite Geodataset, input raster defining the value that determines the number of times the set of rasters is equal to it. 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 Composite Geodataset, input raster defining the value that determines the number of times the set of rasters is equal to it. This is a required parameter.

Parameters:
inValueRaster - Composite Geodataset, input raster defining the value that determines the number of times the set of rasters is equal to it.

getInRasters

public Object getInRasters()
Returns the Input rasters parameter of this tool . This parameter is Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and its cell size will be set in the analysis environment, with each location containing the input number. 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 Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and its cell size will be set in the analysis environment, with each location containing the input number. This is a required parameter.

Parameters:
inRasters - Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and its cell size will be set in the analysis environment, with each location containing the input number.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. 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 Raster Dataset, the raster to be created. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the raster to be created.

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