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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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.
Learn more about how Band Collection Statistics works

Software restrictions: none

Usage tips:


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 - Composite Geodataset, input raster bands.
outStatFile - File, a ".txt" extension is required.
Method Detail

getInRasterBands

public Object getInRasterBands()
Returns the Input raster bands parameter of this tool . This parameter is Composite Geodataset, 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 Composite Geodataset, input raster bands. This is a required parameter.

Parameters:
inRasterBands - Composite Geodataset, input raster bands.

getOutStatFile

public Object getOutStatFile()
Returns the Output statistics file parameter of this tool . This parameter is File, 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 File, a ".txt" extension is required. This is a required parameter.

Parameters:
outStatFile - File, a ".txt" extension is required.

getComputeMatrices

public String getComputeMatrices()
Returns the Compute covariance and correlation matrices parameter of this tool . This parameter is String, 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 String, specifies whether covariance and correlation matrices are calculated. This is an optional parameter.

Parameters:
computeMatrices - String, 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