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

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

All Implemented Interfaces:

GPTool

public class ClassProbability
extends AbstractGPTool

Creates a multiband raster of probability bands, with one band being created for each class represented in the input signature file. The Class Probability tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Any signature file created by the Create Signature, Edit Signature, or Iso Cluster tools is a valid entry for the input signature file. These will have a .gsg extension.
• The input a priori probability file must be an ASCII file consisting of two columns. The values in the left column represent class IDs. The values in the right column represent the a priori probabilities for the respective classes. Valid values for class a priori probabilities must be greater than or equal to zero. If zero is specified as a probability, the class will not appear on the output raster. The sum of the specified a priori probabilities must be less than or equal to one. The format of the file is as follows:The classes omitted in the file will receive the average a priori probability of the remaining portion of the value of one. In the above example, all classes from 1 to 8 are represented in the signature file. The a priori probabilities of classes 3 and 6 are missing in the input a priori probability file. Since the sum of all probabilities specified in the above file is equal to 0.8, the remaining portion of the probability (0.2) is divided by the number of classes not specified (2). Therefore, classes 3 and 6 will each be assigned a probability of 0.1.
• The extension for the input a priori probability file can be .txt or .asc.
• 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 value entered for maximum output value sets the upper range of the values in the output probability bands. The default value of 100 creates a multiband raster with each band containing integer values ranging from 0 to 100. Any integer value greater than zero is valid for maximum output value. Only the value of one for the maximum output value argument will result in bands having floating-point values.

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 - the input raster bands. raster bands can be integer or floating point.

inSignatureFile - input signature file whose class signatures are used to generate the a priori probability bands.l a .gsg extension is required.

outMultibandRaster - the output multiband raster dataset. the dataset filename cannot have more than 9 characters.

Method Detail

getInRasterBands

public Object getInRasterBands()

Returns the Input raster bands parameter of this tool . This parameter is the input raster bands. 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 the input raster bands. raster bands can be integer or floating point. This is a required parameter.

Parameters:

inRasterBands - the input raster bands. raster bands can be integer or floating point.

getInSignatureFile

public Object getInSignatureFile()

Returns the Input signature file parameter of this tool . This parameter is input signature file whose class signatures are used to generate the a priori probability bands.l 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 input signature file whose class signatures are used to generate the a priori probability bands.l a .gsg extension is required. This is a required parameter.

Parameters:

inSignatureFile - input signature file whose class signatures are used to generate the a priori probability bands.l a .gsg extension is required.

getOutMultibandRaster

public Object getOutMultibandRaster()

Returns the Output multiband raster parameter of this tool . This parameter is the output multiband raster dataset. the dataset filename cannot have more than 9 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 the output multiband raster dataset. the dataset filename cannot have more than 9 characters. This is a required parameter.

Parameters:

outMultibandRaster - the output multiband raster dataset. the dataset filename cannot have more than 9 characters.

getMaximumOutputValue

public int getMaximumOutputValue()

Returns the Maximum output value parameter of this tool . This parameter is factor for scaling the range of values in the output probability bands. 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 factor for scaling the range of values in the output probability bands. by default, the values range from 0 to 100. This is an optional parameter.

Parameters:

maximumOutputValue - factor for scaling the range of values in the output probability bands. 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 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.

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