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

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

All Implemented Interfaces:

GPTool

public class CellStatistics
extends AbstractGPTool

Calculates a per-cell statistic from multiple rasters. The Cell Statistics tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The order of the input rasters is irrelevant for this tool.
• If a single raster is used as the input, the output will be a duplicate of it.
• If a cell location contains NoData on any of the input rasters, that location will be assigned NoData on the output.

Field Summary

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

vals

Constructor Summary

CellStatistics()
Creates the Cell Statistics tool with defaults.

CellStatistics(Object inRastersOrConstants, Object outRaster)
Creates the Cell Statistics tool with the required parameters.

Method Summary

String	getIgnoreNodata() Returns the Ignore NoData in calculations 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	getStatisticsType() Returns the Overlay statistic 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	setIgnoreNodata(String ignoreNodata) Sets the Ignore NoData in calculations 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 .
void	setStatisticsType(String statisticsType) Sets the Overlay statistic 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

CellStatistics

public CellStatistics()

Creates the Cell Statistics tool with defaults.

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

CellStatistics

public CellStatistics(Object inRastersOrConstants,
                      Object outRaster)

Creates the Cell Statistics 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:

inRastersOrConstants - a list of input rasters for which a statistic will be calculated for each cell within the Analysis window. a number can be used as an input; however, the cell size and extent must first be set in the environment.

outRaster - the output raster. the value is determined by applying the specified statistic type to the input rasters.

Method Detail

getInRastersOrConstants

public Object getInRastersOrConstants()

Returns the Input rasters or constant values parameter of this tool . This parameter is a list of input rasters for which a statistic will be calculated for each cell within the Analysis window. 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 rasters or constant values

setInRastersOrConstants

public void setInRastersOrConstants(Object inRastersOrConstants)

Sets the Input rasters or constant values parameter of this tool . This parameter is a list of input rasters for which a statistic will be calculated for each cell within the Analysis window. 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:

inRastersOrConstants - a list of input rasters for which a statistic will be calculated for each cell within the Analysis window. a number can be used as an input; however, the cell size and extent must first be set in the environment.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the value is determined by applying the specified statistic type to the input rasters. 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. the value is determined by applying the specified statistic type to the input rasters. This is a required parameter.

Parameters:

outRaster - the output raster. the value is determined by applying the specified statistic type to the input rasters.

getStatisticsType

public String getStatisticsType()

Returns the Overlay statistic parameter of this tool . This parameter is statistic type to be calculated. This is an optional parameter.

Returns:

the Overlay statistic

setStatisticsType

public void setStatisticsType(String statisticsType)

Sets the Overlay statistic parameter of this tool . This parameter is statistic type to be calculated. This is an optional parameter.

Parameters:

statisticsType - statistic type to be calculated.

getIgnoreNodata

public String getIgnoreNodata()

Returns the Ignore NoData in calculations parameter of this tool . This parameter is denotes whether NoData values are ignored by the statistic calculation. This is an optional parameter.

Returns:

the Ignore NoData in calculations

setIgnoreNodata

public void setIgnoreNodata(String ignoreNodata)

Sets the Ignore NoData in calculations parameter of this tool . This parameter is denotes whether NoData values are ignored by the statistic calculation. This is an optional parameter.

Parameters:

ignoreNodata - denotes whether NoData values are ignored by the statistic calculation.

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