This document is archived and information here might be outdated.  Recommended version.


IMultivariateOp.PrincipalComponents Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IMultivariateOp.PrincipalComponents Method

Performs principal components analysis on a raster band collection.

[Visual Basic .NET]
Public Function PrincipalComponents ( _
    ByVal rasterBands As IGeoDataset, _
    ByVal dataFile As String, _
    [ByVal numberComponents As Object] _
) As IGeoDataset
[C#]
public IGeoDataset PrincipalComponents (
    IGeoDataset rasterBands,
    string dataFile,
    object numberComponents
);
[C#]

Optional Values

numberComponents   To indicate that this parameter is undefined, pass in Type.Missing.
[C++]
HRESULT PrincipalComponents(
  IGeoDataset* rasterBands,
  BSTR dataFile,
  VARIANT numberComponents,
  IGeoDataset** pcaDataset
);
[C++]

Parameters rasterBands [in]
rasterBands is a parameter of type IGeoDataset dataFile [in] dataFile is a parameter of type BSTR numberComponents [optional] numberComponents 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. pcaDataset [out, retval]
pcaDataset is a parameter of type IGeoDataset

Product Availability

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

Remarks

rasterBands

name(s) of the input rasterband to calculate statistics. The Rasterbands must have common intersecton.

dataFile

name of the output ASCII fille where the principal components parameters will be stored. 

[numberComponents]

number of principle components. The default is equal to the number of input rasterbands

 

See Also

IMultivariateOp Interface