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

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

public class Popularity
extends AbstractGPTool

Determines the value in an argument list that is at a certain level of popularity on a cell-by-cell basis. The particular level of popularity (the number of occurrences of each value) is specified by the first argument. The Popularity tool is contained in the Spatial Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Popularity()
          Creates the Popularity tool with defaults.
Popularity(Object inPopularityRasterOrConstant, Object inRasters, Object outRaster)
          Creates the Popularity tool with the required parameters.
 
Method Summary
 Object getInPopularityRasterOrConstant()
          Returns the Input popularity 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 setInPopularityRasterOrConstant(Object inPopularityRasterOrConstant)
          Sets the Input popularity 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

Popularity

public Popularity()
Creates the Popularity tool with defaults.

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


Popularity

public Popularity(Object inPopularityRasterOrConstant,
                  Object inRasters,
                  Object outRaster)
Creates the Popularity 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:
inPopularityRasterOrConstant - the input raster defining the popularity 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 used to evaluate the popularity of the values for each cell location.
outRaster - the output raster. each cell in the output raster represents the value from the same location of input rasters that meets the input popularity value.
Method Detail

getInPopularityRasterOrConstant

public Object getInPopularityRasterOrConstant()
Returns the Input popularity raster or constant value parameter of this tool . This parameter is the input raster defining the popularity 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 popularity raster or constant value

setInPopularityRasterOrConstant

public void setInPopularityRasterOrConstant(Object inPopularityRasterOrConstant)
Sets the Input popularity raster or constant value parameter of this tool . This parameter is the input raster defining the popularity 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:
inPopularityRasterOrConstant - the input raster defining the popularity 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 used to evaluate the popularity of the values 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 used to evaluate the popularity of the values for each cell location. This is a required parameter.

Parameters:
inRasters - the list of input rasters used to evaluate the popularity of the values for each cell location.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output raster. each cell in the output raster represents the value from the same location of input rasters that meets the input popularity 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. each cell in the output raster represents the value from the same location of input rasters that meets the input popularity value. This is a required parameter.

Parameters:
outRaster - the output raster. each cell in the output raster represents the value from the same location of input rasters that meets the input popularity 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