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

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

All Implemented Interfaces:

GPTool

public class IsoCluster
extends AbstractGPTool

Uses an isodata clustering algorithm to determine the characteristics of the natural groupings of cells in multidimensional attribute space and stores the results in an output ASCII signature file. The Iso Cluster tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Iso Cluster performs clustering of the multivariate data combined in a list of input bands. The resulting signature file can be used as the input for a classification tool, such as , that produces an unsupervised classification raster.
• The minimum valid value for the number of classes is two. There is no maximum number of clusters. In general, more clusters require more iterations.
• To provide the sufficient statistics necessary to generate a signature file for a future classification, each cluster should contain enough cells to accurately represent the cluster. The value entered for the minimum class size should be approximately 10 times larger than the number of layers in the input raster bands.
• The value entered for the sample interval indicates one cell out of every n-by-n block of cells is used in the cluster calculations.
• You shouldn't merge or remove classes or change any of the statistics of the ASCII signature file.
• Generally, the more cells contained in the input rasters extent, the larger the values for minimum class size and sample interval should be specified. Values entered for the sample interval should be small enough that the smallest desirable categories existing in the input data will be appropriately sampled.
• 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 class ID values on the output signature file start at one and sequentially increase to the number of input classes. The assignment of the class numbers is arbitrary.
• Better results will be obtained if all input bands have the same data ranges. If the bands have vastly different data ranges, the data ranges can be transformed to the same range using Map Algebra to perform the equation.

Field Summary

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

vals

Constructor Summary

IsoCluster()
Creates the Iso Cluster tool with defaults.

IsoCluster(Object inRasterBands, Object outSignatureFile, int numberClasses)
Creates the Iso Cluster tool with the required parameters.

Method Summary

Object	getInRasterBands() Returns the Input raster bands parameter of this tool .
int	getMinClassSize() Returns the Minimum class size parameter of this tool .
int	getNumberClasses() Returns the Number of classes parameter of this tool .
int	getNumberIterations() Returns the Number of iterations parameter of this tool .
Object	getOutSignatureFile() Returns the Output signature file parameter of this tool .
int	getSampleInterval() Returns the Sample interval 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	setMinClassSize(int minClassSize) Sets the Minimum class size parameter of this tool .
void	setNumberClasses(int numberClasses) Sets the Number of classes parameter of this tool .
void	setNumberIterations(int numberIterations) Sets the Number of iterations parameter of this tool .
void	setOutSignatureFile(Object outSignatureFile) Sets the Output signature file parameter of this tool .
void	setSampleInterval(int sampleInterval) Sets the Sample interval 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

IsoCluster

public IsoCluster()

Creates the Iso Cluster tool with defaults.

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

IsoCluster

public IsoCluster(Object inRasterBands,
                  Object outSignatureFile,
                  int numberClasses)

Creates the Iso Cluster 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.

outSignatureFile - the output signature file. a .gsg extension must be specified.

numberClasses - number of classes into which to group the cells.

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.

getOutSignatureFile

public Object getOutSignatureFile()

Returns the Output signature file parameter of this tool . This parameter is the output signature file. a .gsg extension must be specified. This is a required parameter.

Returns:

the Output signature file

setOutSignatureFile

public void setOutSignatureFile(Object outSignatureFile)

Sets the Output signature file parameter of this tool . This parameter is the output signature file. a .gsg extension must be specified. This is a required parameter.

Parameters:

outSignatureFile - the output signature file. a .gsg extension must be specified.

getNumberClasses

public int getNumberClasses()

Returns the Number of classes parameter of this tool . This parameter is number of classes into which to group the cells. This is a required parameter.

Returns:

the Number of classes

setNumberClasses

public void setNumberClasses(int numberClasses)

Sets the Number of classes parameter of this tool . This parameter is number of classes into which to group the cells. This is a required parameter.

Parameters:

numberClasses - number of classes into which to group the cells.

getNumberIterations

public int getNumberIterations()

Returns the Number of iterations parameter of this tool . This parameter is number of iterations of the clustering process to run. the default is 20. This is an optional parameter.

Returns:

the Number of iterations

setNumberIterations

public void setNumberIterations(int numberIterations)

Sets the Number of iterations parameter of this tool . This parameter is number of iterations of the clustering process to run. the default is 20. This is an optional parameter.

Parameters:

numberIterations - number of iterations of the clustering process to run. the default is 20.

getMinClassSize

public int getMinClassSize()

Returns the Minimum class size parameter of this tool . This parameter is minimum number of cells in a valid class. the default is 20. This is an optional parameter.

Returns:

the Minimum class size

setMinClassSize

public void setMinClassSize(int minClassSize)

Sets the Minimum class size parameter of this tool . This parameter is minimum number of cells in a valid class. the default is 20. This is an optional parameter.

Parameters:

minClassSize - minimum number of cells in a valid class. the default is 20.

getSampleInterval

public int getSampleInterval()

Returns the Sample interval parameter of this tool . This parameter is the interval to be used for sampling. the default is 10. This is an optional parameter.

Returns:

the Sample interval

setSampleInterval

public void setSampleInterval(int sampleInterval)

Sets the Sample interval parameter of this tool . This parameter is the interval to be used for sampling. the default is 10. This is an optional parameter.

Parameters:

sampleInterval - the interval to be used for sampling. the default is 10.

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