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

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

public class ClassProbability
extends AbstractGPTool

Creates probability layers for each class in a signature file. The Class Probability tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Class Probability works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ClassProbability()
          Creates the Class Probability tool with defaults.
ClassProbability(Object inRasterBands, Object inSignatureFile, Object outMultibandRaster)
          Creates the Class Probability 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 .
 int getMaximumOutputValue()
          Returns the Maximum output value 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 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 setMaximumOutputValue(int maximumOutputValue)
          Sets the Maximum output value 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

ClassProbability

public ClassProbability()
Creates the Class Probability tool with defaults.

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


ClassProbability

public ClassProbability(Object inRasterBands,
                        Object inSignatureFile,
                        Object outMultibandRaster)
Creates the Class Probability 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 - Composite Geodataset, raster bands can be integer or floating point.
inSignatureFile - File, a ".gsg" extension is required.
outMultibandRaster - Raster Dataset, the dataset filename must have less than 10 characters.
Method Detail

getInRasterBands

public Object getInRasterBands()
Returns the Input raster bands parameter of this tool . This parameter is Composite Geodataset, raster bands can be integer or floating point. 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 Composite Geodataset, raster bands can be integer or floating point. This is a required parameter.

Parameters:
inRasterBands - Composite Geodataset, raster bands can be integer or floating point.

getInSignatureFile

public Object getInSignatureFile()
Returns the Input signature file parameter of this tool . This parameter is File, 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 File, a ".gsg" extension is required. This is a required parameter.

Parameters:
inSignatureFile - File, a ".gsg" extension is required.

getOutMultibandRaster

public Object getOutMultibandRaster()
Returns the Output multiband raster parameter of this tool . This parameter is Raster Dataset, the dataset filename 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 Raster Dataset, the dataset filename must have less than 10 characters. This is a required parameter.

Parameters:
outMultibandRaster - Raster Dataset, the dataset filename must have less than 10 characters.

getMaximumOutputValue

public int getMaximumOutputValue()
Returns the Maximum output value parameter of this tool . This parameter is Long, by default, the values range from 0 to 100. This is an optional parameter.

Returns:
the Maximum output value

setMaximumOutputValue

public void setMaximumOutputValue(int maximumOutputValue)
Sets the Maximum output value parameter of this tool . This parameter is Long, by default, the values range from 0 to 100. This is an optional parameter.

Parameters:
maximumOutputValue - Long, by default, the values range from 0 to 100.

getAPrioriProbabilities

public String getAPrioriProbabilities()
Returns the A priori probability weighting parameter of this tool . This parameter is String, 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 String, specifies how a priori probabilities will be determined. This is an optional parameter.

Parameters:
aPrioriProbabilities - String, 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 File, 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 File, the extension for the a priori file can be ".txt" or ".asc". This is an optional parameter.

Parameters:
inAPrioriFile - File, the extension for the a priori 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