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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.BatchCalculateStatistics

All Implemented Interfaces:

GPTool

public class BatchCalculateStatistics

extends AbstractGPTool

Allows you to run the Calculate Statistics tool process on multiple raster datasets. The Batch Calculate Statistics tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• Statistics are used to help ArcGIS better render the raster datasets. Statistics are necessary for the classified renderer and to perform any contrast stretching.
• The input raster datasets can be any valid raster dataset that ArcGIS recognizes. This tool can calculate statistics in a batch process.
• Calculating statistics for a raster is required for rendering your raster dataset with any sort of contrast stretch.
• A skip factor controls the portion of the raster dataset that is used when calculating the statistics. The input value indicates the horizontal or vertical skip factor, where a factor of one will use each pixel and a value of two will use every second pixel. The skip factor can only range from one to the number of columns/rows in the raster dataset.
• Calculating statistics on a grid always uses a skip factor of 1.
• The skip factors for raster datasets stored in a file geodatabase or an ArcSDE geodatabase are quite 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 (for example, if the skip factor is 5 and the closest pyramid level is 4 x 4 pixels, which is level 2) then the software will round down to the next pyramid level (in this case 2) and use that value as the skip factor.
• A skip factor is not used for all raster formats. The raster formats that will calculate statistics and take advantage of the skip factor include: TIFF, IMG, NITF, DTED, RAW, ADRG, CIB, CADRG, Digest, GIS, LAN, CIT, COT, ERS, and all geodatabase raster datasets.
• The ignore value allows you to exclude a specific value from the calculation of statistics. You may want to ignore a value if it is a NoData value or if it will skew your calculation.

Field Summary

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

vals

Constructor Summary

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

BatchCalculateStatistics(java.lang.Object inputRasterDatasets)
Creates the Batch Calculate Statistics tool with the required parameters.

Method Summary

java.lang.String	getBatchCalculateStatisticsSucceeded() Returns the Batch Calculate Statistics Succeeded parameter of this tool (Read only).
java.lang.Object	getIgnoreValues() Returns the Ignore values parameter of this tool .
java.lang.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 .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setIgnoreValues(java.lang.Object ignoreValues) Sets the Ignore values parameter of this tool .
void	setInputRasterDatasets(java.lang.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(java.lang.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 java.lang.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(java.lang.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 the y skip factors are different, the smaller skip factor will be used for both the x and y skip factors. Secondly, 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, then 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 the y skip factors are different, the smaller skip factor will be used for both the x and y skip factors. Secondly, 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, then 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 the y skip factors are different, the smaller skip factor will be used for both the x and y skip factors. Secondly, 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, then 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 is not equal to a pyramid level, then 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 is not equal to a pyramid level, then 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 is not equal to a pyramid level, then the value will be rounded down to match a pyramid level.

getIgnoreValues

public java.lang.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(java.lang.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 java.lang.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 java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias