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

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

All Implemented Interfaces:

GPTool

public class BandCollectionStats
extends AbstractGPTool

Calculates the statistics for a set of raster bands. The Band Collection Statistics tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The raster bands must have a common intersection. If there is none, an error occurs and no output is created.
• If the extents of the raster bands are not the same, the statistics will be calculated on the common spatial extent of all the input raster bands. The cell size will be that of the maximum of the input rasters, by default; otherwise, it will depend on the Raster Analysis environment settings.
• The default setting of the Compute matrices parameter (BRIEF in scripting, unchecked in the tool dialog box) is to only compute the minimum, maximum, mean, and standard deviation of the input raster bands. To calculate these statistics and also the covariance and correlation matrices set the parameter to DETAILED in scripting, or checked in the tool dialog box. A covariance matrix presents the variances of all raster bands along the diagonal from the upper left to lower right and covariances between all raster bands in the remaining entries. The correlation matrix provides the correlation coefficients between each combination of two input bands.
• The statistics are written to the output file in ASCII text format. The extension for the output must be .txt.
• If the input is a layer created from a multiband raster with more than three bands, the operation will consider all the bands associated with the source dataset, not just the three bands that were loaded (symbolized) by the layer. If you want to process a subset of the bands in the source dataset use the tool to create an input layer containing the desired bands.

Field Summary

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

vals

Constructor Summary

BandCollectionStats()
Creates the Band Collection Statistics tool with defaults.

BandCollectionStats(Object inRasterBands, Object outStatFile)
Creates the Band Collection Statistics tool with the required parameters.

Method Summary

String	getComputeMatrices() Returns the Compute covariance and correlation matrices parameter of this tool .
Object	getInRasterBands() Returns the Input raster bands parameter of this tool .
Object	getOutStatFile() Returns the Output statistics file 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	setComputeMatrices(String computeMatrices) Sets the Compute covariance and correlation matrices parameter of this tool .
void	setInRasterBands(Object inRasterBands) Sets the Input raster bands parameter of this tool .
void	setOutStatFile(Object outStatFile) Sets the Output statistics file 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

BandCollectionStats

public BandCollectionStats()

Creates the Band Collection Statistics tool with defaults.

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

BandCollectionStats

public BandCollectionStats(Object inRasterBands,
                           Object outStatFile)

Creates the Band Collection 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:

inRasterBands - the input raster bands.

outStatFile - the output ASCII file containing the statistics. a .txt extension is required.

Method Detail

getInRasterBands

public Object getInRasterBands()

Returns the Input raster bands parameter of this tool . This parameter is the input raster bands. This is a required parameter.

Returns:

the Input raster bands

setInRasterBands

public void setInRasterBands(Object inRasterBands)

Sets the Input raster bands parameter of this tool . This parameter is the input raster bands. This is a required parameter.

Parameters:

inRasterBands - the input raster bands.

getOutStatFile

public Object getOutStatFile()

Returns the Output statistics file parameter of this tool . This parameter is the output ASCII file containing the statistics. a .txt extension is required. This is a required parameter.

Returns:

the Output statistics file

setOutStatFile

public void setOutStatFile(Object outStatFile)

Sets the Output statistics file parameter of this tool . This parameter is the output ASCII file containing the statistics. a .txt extension is required. This is a required parameter.

Parameters:

outStatFile - the output ASCII file containing the statistics. a .txt extension is required.

getComputeMatrices

public String getComputeMatrices()

Returns the Compute covariance and correlation matrices parameter of this tool . This parameter is specifies whether covariance and correlation matrices are calculated. This is an optional parameter.

Returns:

the Compute covariance and correlation matrices

setComputeMatrices

public void setComputeMatrices(String computeMatrices)

Sets the Compute covariance and correlation matrices parameter of this tool . This parameter is specifies whether covariance and correlation matrices are calculated. This is an optional parameter.

Parameters:

computeMatrices - specifies whether covariance and correlation matrices are calculated.

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