com.esri.arcgis.spatialanalyst
Interface IMultivariateOp

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterMultivariateOp

public interface IMultivariateOp
extends Serializable

Provides access to members that perform multivariate analysis on raster data.

Remarks

  • Read the Working with ArcGIS Spatial Analyst objects technical document for general information on implementing Spatial Analyst operations.
  • Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux


    Method Summary
     void bandCollectionStats(IGeoDataset rasterBands, String dataFile, boolean computeMatrices)
              Calculates the statistics for a raster band collection.
     IGeoDataset classProbability(IGeoDataset rasterBands, String signatureFile, int aPrioriWeighting, Object aPrioriFile, Object outputScalingFactor)
              Creates probability layers, for each class in the signature file.
     void createSignatures(IGeoDataset rasterBands, IGeoDataset sampleDataset, String signatureFile, boolean computeCovariance)
              Creates an ascii signature file of classes defined in an input dataset.
     void dendrogram(String signatureFile, String dendrogramFile, boolean computeWithVariance, Object lineWidth)
              Constructs a tree diagram showing attribute distances between sequentially merged classes in a signature file.
     void editSignatures(IGeoDataset rasterBands, String signatureFile, String signatureRemapFile, String newSignatureFile, Object sampleInterval)
              Edits and updates a signature file.
     void isoCluster(IGeoDataset rasterBands, String signatureFile, int numberClasses, Object numberIterations, Object minimumClassSize, Object sampleInterval)
              Uses isodata clustering to get characteristics of natural cell groupings in multi-dimension attribute space.
     IGeoDataset mLClassify(IGeoDataset rasterBands, String signatureFile, boolean createConfidenceOutput, int aPrioriWeighting, Object aPrioriFile, Object rejectFraction)
              Performs a maximum-likelihood classification on a raster band collection.
     IGeoDataset principalComponents(IGeoDataset rasterBands, String dataFile, Object numberComponents)
              Performs principal components analysis on a raster band collection.
     

    Method Detail

    classProbability

    IGeoDataset classProbability(IGeoDataset rasterBands,
                                 String signatureFile,
                                 int aPrioriWeighting,
                                 Object aPrioriFile,
                                 Object outputScalingFactor)
                                 throws IOException,
                                        AutomationException
    Creates probability layers, for each class in the signature file.

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    rasterBands - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    signatureFile - The signatureFile (in)
    aPrioriWeighting - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisAPrioriEnum constant (in)
    aPrioriFile - A Variant (in, optional, pass null if not required)
    outputScalingFactor - A Variant (in, optional, pass null if not required)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    createSignatures

    void createSignatures(IGeoDataset rasterBands,
                          IGeoDataset sampleDataset,
                          String signatureFile,
                          boolean computeCovariance)
                          throws IOException,
                                 AutomationException
    Creates an ascii signature file of classes defined in an input dataset.

    Remarks

    rasterBands

    name of a multiband Raster to derive class signatures using class samples defined by the sampleDataset

    sampleDataset

    name of the input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor delineating the set of class samples

    signatureFile

    name of the output signature file

    [computeCovariance]

    Boolean specifying whether the covariance matrices will be calculated

    If True, then the covariance matrices and the means for all classes of the sampleDataset will be computed.

    If False, only the means for all classes of the sampleDataset will be calculated.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    rasterBands - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    sampleDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    signatureFile - The signatureFile (in)
    computeCovariance - The computeCovariance (in, optional, pass false if not required)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    dendrogram

    void dendrogram(String signatureFile,
                    String dendrogramFile,
                    boolean computeWithVariance,
                    Object lineWidth)
                    throws IOException,
                           AutomationException
    Constructs a tree diagram showing attribute distances between sequentially merged classes in a signature file.

    Remarks

    signatureFile

    name of the input signature file whose class signatures are used to produce a dendrogram.A “.gsg” extension is required.

    dendrogramFile

    the path to an output dendrogram file. The file contains a table of distances between pairs of sequentially merged classes and a graphical representation showing the relationships among classes and the hierarchy of the merging.

    [computeWithVariance]

    A Boolean specifying the manner in which the distances between classes in multi-dimensional attribute space are defined.

    If True, The distances between classes will be computed based on the variances and the Euclidean distance between the means of their signatures.

    If False, The distances between classes will be determined only by the Euclidean distances between the means of the class signatures.

    [lineWidth]

    The value specifies the width of the graph based on the number of characters. The default value of 78, is also the minimum valid number to be entered.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    signatureFile - The signatureFile (in)
    dendrogramFile - The dendrogramFile (in)
    computeWithVariance - The computeWithVariance (in, optional, pass false if not required)
    lineWidth - A Variant (in, optional, pass null if not required)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    editSignatures

    void editSignatures(IGeoDataset rasterBands,
                        String signatureFile,
                        String signatureRemapFile,
                        String newSignatureFile,
                        Object sampleInterval)
                        throws IOException,
                               AutomationException
    Edits and updates a signature file.

    Remarks

    rasterBands

    the name of a multiband Raster from which the signature file to be edited was created

    signatureFile

    the name of the input signature file to be edited

    signatureRemapFile

    an ASCII remap table containing the pairs of class IDs to be merged, renumbered, or deleted

    newsignatureFile

    the name of the output signature file

    [sampleInterval]

    the interval for sampling

    A common interval is 10.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    rasterBands - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    signatureFile - The signatureFile (in)
    signatureRemapFile - The signatureRemapFile (in)
    newSignatureFile - The newSignatureFile (in)
    sampleInterval - A Variant (in, optional, pass null if not required)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    isoCluster

    void isoCluster(IGeoDataset rasterBands,
                    String signatureFile,
                    int numberClasses,
                    Object numberIterations,
                    Object minimumClassSize,
                    Object sampleInterval)
                    throws IOException,
                           AutomationException
    Uses isodata clustering to get characteristics of natural cell groupings in multi-dimension attribute space.

    Remarks

    rasterBands

    name of a multiband Raster signatures to be used for clustering

    SignatureFile

    name of the output signature file

    numberClasses

    the number of classes to group the cells

    [numberIterations]

    the number of iterations of the clustering process. A commonly used number of iterations is 20

    [minimumClassSize]

    the minimum number of cells in a valid class. A commonly used minimum class size is 20

    [sampleInterval]

    the interval of sampling. A common sample interval is 10

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    rasterBands - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    signatureFile - The signatureFile (in)
    numberClasses - The numberClasses (in)
    numberIterations - A Variant (in, optional, pass null if not required)
    minimumClassSize - A Variant (in, optional, pass null if not required)
    sampleInterval - A Variant (in, optional, pass null if not required)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    mLClassify

    IGeoDataset mLClassify(IGeoDataset rasterBands,
                           String signatureFile,
                           boolean createConfidenceOutput,
                           int aPrioriWeighting,
                           Object aPrioriFile,
                           Object rejectFraction)
                           throws IOException,
                                  AutomationException
    Performs a maximum-likelihood classification on a raster band collection.

    Remarks

    rasterBands

    name of a multiband Raster to perform the classification

    signatureFile

    name of the signature file whose class signatures are used by the maximum-likelihood classifier when performing the classification of the rasterBands

    createConfidenceOutput

    an optional output Raster showing the certainty of the classification in 14 levels of confidence with the lowest values representing the highest reliability

    If the Boolean is set to True, the output Raster will be created.

    APrioriWeighting

    an esriGeoAnalysisAPrioriEnum specifying the type of a priori probabilities, or weights, for the classes represented in the aPriorFile

    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]

    a file containing user-defined a priori probabilities for the classes

    [rejectFraction]

    the portion of cells that will remain unclassified due to the lowest possibility of correct assignment

    The most common reject fraction is 0.0, indicating 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, 0.995.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    rasterBands - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    signatureFile - The signatureFile (in)
    createConfidenceOutput - The createConfidenceOutput (in, optional, pass false if not required)
    aPrioriWeighting - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisAPrioriEnum constant (in, optional, pass 1 if not required)
    aPrioriFile - A Variant (in, optional, pass null if not required)
    rejectFraction - A Variant (in, optional, pass null if not required)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    principalComponents

    IGeoDataset principalComponents(IGeoDataset rasterBands,
                                    String dataFile,
                                    Object numberComponents)
                                    throws IOException,
                                           AutomationException
    Performs principal components analysis on a raster band collection.

    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

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    rasterBands - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    dataFile - The dataFile (in)
    numberComponents - A Variant (in, optional, pass null if not required)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    bandCollectionStats

    void bandCollectionStats(IGeoDataset rasterBands,
                             String dataFile,
                             boolean computeMatrices)
                             throws IOException,
                                    AutomationException
    Calculates the statistics for a raster band collection.

    Remarks

    rasterBands

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

    dataFile

    name of the output statistics file. An extension is required. Any extension can be used, but ".txt" is reccommended

    [computeMatrices]

    a Boolean specifying whether covariance and correlation matices are calculated.

    If TRUE, In addition to the standard statistics calculated, the covariance and correlation matieces will also be determined

    If FALSE, Only the basic statistical measures (minimum, maximum, mean, and standard deviation) will be calculated for every layer.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    rasterBands - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    dataFile - The dataFile (in)
    computeMatrices - The computeMatrices (in, optional, pass false if not required)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.