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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.MLClassify
All Implemented Interfaces:
GPTool

public class MLClassify
extends AbstractGPTool

Performs a maximum likelihood classification on a set of raster bands and creates a classified raster as output. The Maximum Likelihood 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
MLClassify()
          Creates the Maximum Likelihood Classification tool with defaults.
MLClassify(Object inRasterBands, Object inSignatureFile, Object outClassifiedRaster)
          Creates the Maximum Likelihood Classification tool with the required parameters.
 
Method Summary
 String getAPrioriProbabilities()
          Returns the A priori probability weighting parameter of this tool .
 Object getInAPrioriFile()
          Returns the Input a priori probability file parameter of this tool .
 Object getInRasterBands()
          Returns the Input raster bands parameter of this tool .
 Object getInSignatureFile()
          Returns the Input signature file parameter of this tool .
 Object getOutClassifiedRaster()
          Returns the Output classified raster parameter of this tool .
 Object getOutConfidenceRaster()
          Returns the Output confidence raster parameter of this tool .
 String getRejectFraction()
          Returns the Reject fraction 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 setAPrioriProbabilities(String aPrioriProbabilities)
          Sets the A priori probability weighting parameter of this tool .
 void setInAPrioriFile(Object inAPrioriFile)
          Sets the Input a priori probability file parameter of this tool .
 void setInRasterBands(Object inRasterBands)
          Sets the Input raster bands parameter of this tool .
 void setInSignatureFile(Object inSignatureFile)
          Sets the Input signature file parameter of this tool .
 void setOutClassifiedRaster(Object outClassifiedRaster)
          Sets the Output classified raster parameter of this tool .
 void setOutConfidenceRaster(Object outConfidenceRaster)
          Sets the Output confidence raster parameter of this tool .
 void setRejectFraction(String rejectFraction)
          Sets the Reject fraction 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

MLClassify

public MLClassify()
Creates the Maximum Likelihood Classification tool with defaults.

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


MLClassify

public MLClassify(Object inRasterBands,
                  Object inSignatureFile,
                  Object outClassifiedRaster)
Creates the Maximum Likelihood 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:
inRasterBands - the input raster bands.
inSignatureFile - the input signature file whose class signatures are used by the maximum likelihood classifier. a .gsg extension is required.
outClassifiedRaster - the output classified raster.
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.

getInSignatureFile

public Object getInSignatureFile()
Returns the Input signature file parameter of this tool . This parameter is the input signature file whose class signatures are used by the maximum likelihood classifier. a .gsg extension is required. This is a required parameter.

Returns:
the Input signature file

setInSignatureFile

public void setInSignatureFile(Object inSignatureFile)
Sets the Input signature file parameter of this tool . This parameter is the input signature file whose class signatures are used by the maximum likelihood classifier. a .gsg extension is required. This is a required parameter.

Parameters:
inSignatureFile - the input signature file whose class signatures are used by the maximum likelihood classifier. a .gsg extension is required.

getOutClassifiedRaster

public Object getOutClassifiedRaster()
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

setOutClassifiedRaster

public void setOutClassifiedRaster(Object outClassifiedRaster)
Sets the Output classified raster parameter of this tool . This parameter is the output classified raster. This is a required parameter.

Parameters:
outClassifiedRaster - the output classified raster.

getRejectFraction

public String getRejectFraction()
Returns the Reject fraction parameter of this tool . This parameter is portion of cells that will remain unclassified due to the lowest possibility of correct assignments. the default is 0.0; therefore, every cell will be classified. the 14 valid entries are: 0.0, 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 0.75, 0.9, 0.95, 0.975, 0.99, and 0.995. This is an optional parameter.

Returns:
the Reject fraction

setRejectFraction

public void setRejectFraction(String rejectFraction)
Sets the Reject fraction parameter of this tool . This parameter is portion of cells that will remain unclassified due to the lowest possibility of correct assignments. the default is 0.0; therefore, every cell will be classified. the 14 valid entries are: 0.0, 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 0.75, 0.9, 0.95, 0.975, 0.99, and 0.995. This is an optional parameter.

Parameters:
rejectFraction - portion of cells that will remain unclassified due to the lowest possibility of correct assignments. the default is 0.0; therefore, every cell will be classified. the 14 valid entries are: 0.0, 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 0.75, 0.9, 0.95, 0.975, 0.99, and 0.995.

getAPrioriProbabilities

public String getAPrioriProbabilities()
Returns the A priori probability weighting parameter of this tool . This parameter is specifies how a priori probabilities will be determined. This is an optional parameter.

Returns:
the A priori probability weighting

setAPrioriProbabilities

public void setAPrioriProbabilities(String aPrioriProbabilities)
Sets the A priori probability weighting parameter of this tool . This parameter is specifies how a priori probabilities will be determined. This is an optional parameter.

Parameters:
aPrioriProbabilities - specifies how a priori probabilities will be determined.

getInAPrioriFile

public Object getInAPrioriFile()
Returns the Input a priori probability file parameter of this tool . This parameter is a text file containing a priori probabilities for the input signature classes. an input for the a priori probability file is only required when the FILE option is used. the extension for the a priori file can be .txt or .asc. This is an optional parameter.

Returns:
the Input a priori probability file

setInAPrioriFile

public void setInAPrioriFile(Object inAPrioriFile)
Sets the Input a priori probability file parameter of this tool . This parameter is a text file containing a priori probabilities for the input signature classes. an input for the a priori probability file is only required when the FILE option is used. the extension for the a priori file can be .txt or .asc. This is an optional parameter.

Parameters:
inAPrioriFile - a text file containing a priori probabilities for the input signature classes. an input for the a priori probability file is only required when the FILE option is used. the extension for the a priori file can be .txt or .asc.

getOutConfidenceRaster

public Object getOutConfidenceRaster()
Returns the Output confidence raster parameter of this tool . This parameter is output confidence raster dataset showing the certainty of the classification in 14 levels of confidence, with the lowest values representing the highest reliability. This is an optional parameter.

Returns:
the Output confidence raster

setOutConfidenceRaster

public void setOutConfidenceRaster(Object outConfidenceRaster)
Sets the Output confidence raster parameter of this tool . This parameter is output confidence raster dataset showing the certainty of the classification in 14 levels of confidence, with the lowest values representing the highest reliability. This is an optional parameter.

Parameters:
outConfidenceRaster - output confidence raster dataset showing the certainty of the classification in 14 levels of confidence, with the lowest values representing the highest reliability.

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