ArcObjects Library Reference (SpatialAnalyst)  

IMultivariateOp.ClassProbability Method

Creates probability layers, for each class in the signature file.

[Visual Basic .NET]
Public Function ClassProbability ( _
    ByVal rasterBands As IGeoDataset, _
    ByVal signatureFile As String, _
    ByVal aPrioriWeighting As esriGeoAnalysisAPrioriEnum, _
    [ByVal aPrioriFile As Object], _
    [ByVal outputScalingFactor As Object] _
) As IGeoDataset
[C#]
public IGeoDataset ClassProbability (
    IGeoDataset rasterBands,
    string signatureFile,
    esriGeoAnalysisAPrioriEnum aPrioriWeighting,
    object aPrioriFile,
    object outputScalingFactor
);
[C#]

Optional Values

aPrioriFile   To indicate that this parameter is undefined, pass in Type.Missing.
outputScalingFactor   To indicate that this parameter is undefined, pass in Type.Missing.
[C++]
HRESULT ClassProbability(
  IGeoDataset* rasterBands,
  BSTR signatureFile,
  esriGeoAnalysisAPrioriEnum aPrioriWeighting,
  VARIANT aPrioriFile,
  VARIANT outputScalingFactor,
  IGeoDataset** probabilityStack
);
[C++]

Parameters

rasterBands [in]

  rasterBands is a parameter of type IGeoDataset

signatureFile [in]
  signatureFile is a parameter of type BSTR
aPrioriWeighting [in]

  aPrioriWeighting is a parameter of type esriGeoAnalysisAPrioriEnum

aPrioriFile [optional]
  aPrioriFile is a parameter of type VARIANT

  To indicate this parameter is undefined pass in a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

outputScalingFactor [optional]
  outputScalingFactor is a parameter of type VARIANT

  To indicate this parameter is undefined pass in a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

probabilityStack [out, retval]

  probabilityStack is a parameter of type IGeoDataset

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Remarks

rasterBands

name of the input rasterBand to derive the probability layers

signatureFile

name of the signature file whose class signatures are used to generate the posteriori probability layers in the output stack

aPrioriWeighting

enumeration specifying the a priori probabilities, or weights, for the classes represented in the signature file

The enumeration types are:

esriGeoAnalysisEqual all classes will have the same a priori probability

esriGeoAnalysisSample a priori probabilities will be proportional to the number of cells in each class relative to the total number of cells sampled in all classes in the signature file

esriGeoAnalysisAPrioriFile a priori probabilities will be assigned to each class from an aPrioriFile ASCII file

[aPrioriFile]

an ASCII file containing a priori probabilities for the classes of the input signature file

[outputScalingFactor]

factor for scaling the range of values in the output probability layers

The outputScalingFactor is a number such as 2, 10, or 5.5 and can either be an integer or floating point value.

 

See Also

IMultivariateOp Interface