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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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:


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