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

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

public class BatchCalculateStatistics
extends AbstractGPTool

Runs the Calculate Statistics process on multiple raster datasets. The Batch 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
BatchCalculateStatistics()
          Creates the Batch Calculate Statistics tool with defaults.
BatchCalculateStatistics(Object inputRasterDatasets)
          Creates the Batch Calculate Statistics tool with the required parameters.
 
Method Summary
 String getBatchCalculateStatisticsSucceeded()
          Returns the Batch Calculate Statistics Succeeded parameter of this tool (Read only).
 Object getIgnoreValues()
          Returns the Ignore values parameter of this tool .
 Object getInputRasterDatasets()
          Returns the Input Raster Datasets parameter of this tool .
 int getNumberOfColumnsToSkip()
          Returns the Number of columns to skip parameter of this tool .
 int getNumberOfRowsToSkip()
          Returns the Number of rows to skip 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 setIgnoreValues(Object ignoreValues)
          Sets the Ignore values parameter of this tool .
 void setInputRasterDatasets(Object inputRasterDatasets)
          Sets the Input Raster Datasets parameter of this tool .
 void setNumberOfColumnsToSkip(int numberOfColumnsToSkip)
          Sets the Number of columns to skip parameter of this tool .
 void setNumberOfRowsToSkip(int numberOfRowsToSkip)
          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

BatchCalculateStatistics

public BatchCalculateStatistics()
Creates the Batch Calculate Statistics tool with defaults.

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


BatchCalculateStatistics

public BatchCalculateStatistics(Object inputRasterDatasets)
Creates the Batch 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:
inputRasterDatasets - Raster dataset, the input raster datasets.
Method Detail

getInputRasterDatasets

public Object getInputRasterDatasets()
Returns the Input Raster Datasets parameter of this tool . This parameter is Raster dataset, the input raster datasets. This is a required parameter.

Returns:
the Input Raster Datasets

setInputRasterDatasets

public void setInputRasterDatasets(Object inputRasterDatasets)
Sets the Input Raster Datasets parameter of this tool . This parameter is Raster dataset, the input raster datasets. This is a required parameter.

Parameters:
inputRasterDatasets - Raster dataset, the input raster datasets.

getNumberOfColumnsToSkip

public int getNumberOfColumnsToSkip()
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 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

setNumberOfColumnsToSkip

public void setNumberOfColumnsToSkip(int numberOfColumnsToSkip)
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 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:
numberOfColumnsToSkip - Long, the skip factors for raster datasets stored in a file geodatabase or an ArcSDE geodatabase are different. First, if the x and 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.

getNumberOfRowsToSkip

public int getNumberOfRowsToSkip()
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 values are not equal, then the smaller number is used. If skip factor values are 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

setNumberOfRowsToSkip

public void setNumberOfRowsToSkip(int numberOfRowsToSkip)
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 values are not equal, then the smaller number is used. If skip factor values are not equal to a pyramid level, the value will be rounded down to match a pyramid level. This is an optional parameter.

Parameters:
numberOfRowsToSkip - Long, for raster datasets in a file or ArcSDE geodatabase, if the skip values are not equal, then the smaller number is used. If skip factor values are 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 Double, the default is no value. 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 Double, the default is no value. This is an optional parameter.

Parameters:
ignoreValues - Double, the default is no value.

getBatchCalculateStatisticsSucceeded

public String getBatchCalculateStatisticsSucceeded()
Returns the Batch Calculate Statistics Succeeded parameter of this tool (Read only). This is an derived parameter.

Returns:
the Batch Calculate Statistics Succeeded

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