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

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

All Implemented Interfaces:

GPTool

public class PrincipalComponents
extends AbstractGPTool

Performs Principal Component Analysis (PCA) on a set of raster bands and generates a single multiband raster as output. The Principal Components tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The value specified for the number of principal components determines the number of principal component bands in the output multiband raster. The number must not be larger than the total number of raster bands in the input.
• 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.
• The raster bands must have a common intersection. If there is none, an error occurs and no output is created.
• With the output data file name specified, the correlation and covariance matrices, as well as the eigenvalues and eigenvectors, will be stored in an ASCII file.

Field Summary

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

vals

Constructor Summary

PrincipalComponents()
Creates the Principal Components tool with defaults.

PrincipalComponents(Object inRasterBands, Object outMultibandRaster)
Creates the Principal Components tool with the required parameters.

Method Summary

Object	getInRasterBands() Returns the Input raster bands parameter of this tool .
int	getNumberComponents() Returns the Number of Principal components parameter of this tool .
Object	getOutDataFile() Returns the Output data file parameter of this tool .
Object	getOutMultibandRaster() Returns the Output multiband raster 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	setInRasterBands(Object inRasterBands) Sets the Input raster bands parameter of this tool .
void	setNumberComponents(int numberComponents) Sets the Number of Principal components parameter of this tool .
void	setOutDataFile(Object outDataFile) Sets the Output data file parameter of this tool .
void	setOutMultibandRaster(Object outMultibandRaster) Sets the Output multiband raster 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

PrincipalComponents

public PrincipalComponents()

Creates the Principal Components tool with defaults.

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

PrincipalComponents

public PrincipalComponents(Object inRasterBands,
                           Object outMultibandRaster)

Creates the Principal Components 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.

outMultibandRaster - the output multiband raster dataset. the dataset file name must have less than 10 characters.

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.

getOutMultibandRaster

public Object getOutMultibandRaster()

Returns the Output multiband raster parameter of this tool . This parameter is the output multiband raster dataset. the dataset file name must have less than 10 characters. This is a required parameter.

Returns:

the Output multiband raster

setOutMultibandRaster

public void setOutMultibandRaster(Object outMultibandRaster)

Sets the Output multiband raster parameter of this tool . This parameter is the output multiband raster dataset. the dataset file name must have less than 10 characters. This is a required parameter.

Parameters:

outMultibandRaster - the output multiband raster dataset. the dataset file name must have less than 10 characters.

getNumberComponents

public int getNumberComponents()

Returns the Number of Principal components parameter of this tool . This parameter is number of principal components. the number must be greater than zero and less than or equal to the total number of input raster bands. the default is the total number of rasters in the input. This is an optional parameter.

Returns:

the Number of Principal components

setNumberComponents

public void setNumberComponents(int numberComponents)

Sets the Number of Principal components parameter of this tool . This parameter is number of principal components. the number must be greater than zero and less than or equal to the total number of input raster bands. the default is the total number of rasters in the input. This is an optional parameter.

Parameters:

numberComponents - number of principal components. the number must be greater than zero and less than or equal to the total number of input raster bands. the default is the total number of rasters in the input.

getOutDataFile

public Object getOutDataFile()

Returns the Output data file parameter of this tool . This parameter is output ASCII data file storing principal component parameters. the extension for the output file can be .txt or .asc. This is an optional parameter.

Returns:

the Output data file

setOutDataFile

public void setOutDataFile(Object outDataFile)

Sets the Output data file parameter of this tool . This parameter is output ASCII data file storing principal component parameters. the extension for the output file can be .txt or .asc. This is an optional parameter.

Parameters:

outDataFile - output ASCII data file storing principal component parameters. the extension for the output file can be .txt or .asc.

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