com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CalculateStatistics

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

public class CalculateStatistics
extends AbstractGPTool

Calculates statistics for a raster dataset. Statistics are required for your raster dataset to perform certain tasks, such as applying a contrast stretch or classifying your data. The Calculate Statistics tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CalculateStatistics()
          Creates the Calculate Statistics tool with defaults.
CalculateStatistics(Object inRasterDataset)
          Creates the Calculate Statistics tool with the required parameters.
 
Method Summary
 Object getIgnoreValues()
          Returns the Ignore Values parameter of this tool .
 Object getInRasterDataset()
          Returns the Input Raster Dataset parameter of this tool .
 Object getOutRaster()
          Returns the Output Raster Dataset parameter of this tool (Read only).
 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.
 int getXSkipFactor()
          Returns the Number of Columns to Skip parameter of this tool .
 int getYSkipFactor()
          Returns the Number of Rows to Skip parameter of this tool .
 void setIgnoreValues(Object ignoreValues)
          Sets the Ignore Values parameter of this tool .
 void setInRasterDataset(Object inRasterDataset)
          Sets the Input Raster Dataset parameter of this tool .
 void setXSkipFactor(int xSkipFactor)
          Sets the Number of Columns to Skip parameter of this tool .
 void setYSkipFactor(int ySkipFactor)
          Sets the Number of Rows to Skip 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

CalculateStatistics

public CalculateStatistics()
Creates the Calculate Statistics tool with defaults.

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


CalculateStatistics

public CalculateStatistics(Object inRasterDataset)
Creates the Calculate 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:
inRasterDataset - Composite geodataset, the input raster dataset.
Method Detail

getInRasterDataset

public Object getInRasterDataset()
Returns the Input Raster Dataset parameter of this tool . This parameter is Composite geodataset, the input raster dataset. This is a required parameter.

Returns:
the Input Raster Dataset

setInRasterDataset

public void setInRasterDataset(Object inRasterDataset)
Sets the Input Raster Dataset parameter of this tool . This parameter is Composite geodataset, the input raster dataset. This is a required parameter.

Parameters:
inRasterDataset - Composite geodataset, the input raster dataset.

getXSkipFactor

public int getXSkipFactor()
Returns the Number of Columns to Skip parameter of this tool . This parameter is Long, the skip factors for raster datasets stored in a file geodatabase or an ArcSDE geodatabase are different. First, if the x and the y skip factors are different, the smaller skip factor will be used for both the x and y skip factors. Second, the skip factor is related to the pyramid level that most closely fits the skip factor chosen. If the skip factor value is not equal to the number of pixels in a pyramid layer, the number is rounded down to the next pyramid level and those statistics are used. This is an optional parameter.

Returns:
the Number of Columns to Skip

setXSkipFactor

public void setXSkipFactor(int xSkipFactor)
Sets the Number of Columns to Skip parameter of this tool . This parameter is Long, the skip factors for raster datasets stored in a file geodatabase or an ArcSDE geodatabase are different. First, if the x and the y skip factors are different, the smaller skip factor will be used for both the x and y skip factors. Second, the skip factor is related to the pyramid level that most closely fits the skip factor chosen. If the skip factor value is not equal to the number of pixels in a pyramid layer, the number is rounded down to the next pyramid level and those statistics are used. This is an optional parameter.

Parameters:
xSkipFactor - Long, the skip factors for raster datasets stored in a file geodatabase or an ArcSDE geodatabase are different. First, if the x and the y skip factors are different, the smaller skip factor will be used for both the x and y skip factors. Second, the skip factor is related to the pyramid level that most closely fits the skip factor chosen. If the skip factor value is not equal to the number of pixels in a pyramid layer, the number is rounded down to the next pyramid level and those statistics are used.

getYSkipFactor

public int getYSkipFactor()
Returns the Number of Rows to Skip parameter of this tool . This parameter is Long, for raster datasets in a file or ArcSDE geodatabase, if the skip factor values are not equal, the smaller number is used. If the skip factor is not equal to a pyramid level, the value will be rounded down to match a pyramid level. This is an optional parameter.

Returns:
the Number of Rows to Skip

setYSkipFactor

public void setYSkipFactor(int ySkipFactor)
Sets the Number of Rows to Skip parameter of this tool . This parameter is Long, for raster datasets in a file or ArcSDE geodatabase, if the skip factor values are not equal, the smaller number is used. If the skip factor is not equal to a pyramid level, the value will be rounded down to match a pyramid level. This is an optional parameter.

Parameters:
ySkipFactor - Long, for raster datasets in a file or ArcSDE geodatabase, if the skip factor values are not equal, the smaller number is used. If the skip factor is not equal to a pyramid level, the value will be rounded down to match a pyramid level.

getIgnoreValues

public Object getIgnoreValues()
Returns the Ignore Values parameter of this tool . This parameter is Long, the pixel values that are not to be included in the statistics calculation. The default is no value or the last ignore values used. This is an optional parameter.

Returns:
the Ignore Values

setIgnoreValues

public void setIgnoreValues(Object ignoreValues)
Sets the Ignore Values parameter of this tool . This parameter is Long, the pixel values that are not to be included in the statistics calculation. The default is no value or the last ignore values used. This is an optional parameter.

Parameters:
ignoreValues - Long, the pixel values that are not to be included in the statistics calculation. The default is no value or the last ignore values used.

getOutRaster

public Object getOutRaster()
Returns the Output Raster Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Raster Dataset

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