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

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

All Implemented Interfaces:

GPTool

public class IsoClusterUnsupervisedClassification
extends AbstractGPTool

Performs unsupervised classification on an input multiband raster using the Iso Cluster and Maximum Likelihood Classification tools. The Iso Cluster Unsupervised Classification tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• This tool combines the functions of the Iso Cluster and Maximum Likelihood Classification tools. It outputs a classified image. It optionally outputs a signature file.
• The resulting signature file from this tool can be used as the input for a classification tool, such as Maximum Likelihood Classification, 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.
• The output signature file's name must have a .gsg extension.
• Better results will be obtained if all input rasters have the same data ranges. If the layers 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

IsoClusterUnsupervisedClassification()
Creates the Iso Cluster Unsupervised Classification tool with defaults.

IsoClusterUnsupervisedClassification(Object inputRasterBands, int numberOfClasses, Object outputClassifiedRaster)
Creates the Iso Cluster Unsupervised Classification tool with the required parameters.

Method Summary

Object	getInputRasterBands() Returns the Input raster bands parameter of this tool .
int	getMinimumClassSize() Returns the Minimum class size parameter of this tool .
int	getNumberOfClasses() Returns the Number of classes parameter of this tool .
Object	getOutputClassifiedRaster() Returns the Output classified raster parameter of this tool .
Object	getOutputSignatureFile() 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	setInputRasterBands(Object inputRasterBands) Sets the Input raster bands parameter of this tool .
void	setMinimumClassSize(int minimumClassSize) Sets the Minimum class size parameter of this tool .
void	setNumberOfClasses(int numberOfClasses) Sets the Number of classes parameter of this tool .
void	setOutputClassifiedRaster(Object outputClassifiedRaster) Sets the Output classified raster parameter of this tool .
void	setOutputSignatureFile(Object outputSignatureFile) 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

IsoClusterUnsupervisedClassification

public IsoClusterUnsupervisedClassification()

Creates the Iso Cluster Unsupervised Classification tool with defaults.

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

IsoClusterUnsupervisedClassification

public IsoClusterUnsupervisedClassification(Object inputRasterBands,
                                            int numberOfClasses,
                                            Object outputClassifiedRaster)

Creates the Iso Cluster Unsupervised Classification 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:

inputRasterBands - the input raster bands.

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

outputClassifiedRaster - the output classified raster.

Method Detail

getInputRasterBands

public Object getInputRasterBands()

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

setInputRasterBands

public void setInputRasterBands(Object inputRasterBands)

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

Parameters:

inputRasterBands - the input raster bands.

getNumberOfClasses

public int getNumberOfClasses()

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

setNumberOfClasses

public void setNumberOfClasses(int numberOfClasses)

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:

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

getOutputClassifiedRaster

public Object getOutputClassifiedRaster()

Returns the Output classified raster parameter of this tool . This parameter is the output classified raster. This is a required parameter.

Returns:

the Output classified raster

setOutputClassifiedRaster

public void setOutputClassifiedRaster(Object outputClassifiedRaster)

Sets the Output classified raster parameter of this tool . This parameter is the output classified raster. This is a required parameter.

Parameters:

outputClassifiedRaster - the output classified raster.

getMinimumClassSize

public int getMinimumClassSize()

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

setMinimumClassSize

public void setMinimumClassSize(int minimumClassSize)

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:

minimumClassSize - 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.

getOutputSignatureFile

public Object getOutputSignatureFile()

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

Returns:

the Output signature file

setOutputSignatureFile

public void setOutputSignatureFile(Object outputSignatureFile)

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

Parameters:

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

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