com.esri.arcgis.spatialanalyst
Class RasterMultivariateOp

java.lang.Object
  extended by com.esri.arcgis.spatialanalyst.RasterMultivariateOp
All Implemented Interfaces:
IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, com.esri.arcgis.interop.RemoteObjRef, IMultivariateOp, ISupportErrorInfo, Serializable

public class RasterMultivariateOp
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IMultivariateOp, ISupportErrorInfo

A mechanism for performing multivariate operations on rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RasterMultivariateOp()
          Constructs a RasterMultivariateOp using ArcGIS Engine.
RasterMultivariateOp(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterMultivariateOp theRasterMultivariateOp = (RasterMultivariateOp) obj;
 
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.
 boolean equals(Object o)
          Compare this object with another
 void getCellSize(int[] envType, double[] cellSize)
          Gets the type and value of cell size in the RasterAnalysis.
static String getClsid()
          getClsid.
 String getDefaultOutputRasterPrefix()
          The default output raster prefix.
 String getDefaultOutputVectorPrefix()
          The default output vector prefix.
 void getExtent(int[] envType, IEnvelope[] extent)
          Gets the type and values of extent in the RasterAnalysis.
 IGeoDataset getMask()
          Mask allows processing to occur only for a selected set of cells.
 ISpatialReference getOutSpatialReference()
          The output spatial reference of GeoAnalysis.
 IWorkspace getOutWorkspace()
          The output workspace of GeoAnalysis.
 int getVerifyType()
          The verify type of the RasterAnalysis.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 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.
 void reset()
          Remove all previously stored default rasteranalysis environments.
 void restoreToPreviousDefaultEnvironment()
          Restores to the previous default raster analysis environment.
 void setAsNewDefaultEnvironment()
          Sets the raster analysis environment of the object as new default environment.
 void setCellSize(int envType, Object cellSizeProvider)
          Sets the type and value of cell size in the RasterAnalysis.
 void setDefaultOutputRasterPrefix(String rasterPrefix)
          The default output raster prefix.
 void setDefaultOutputVectorPrefix(String vectorPrefix)
          The default output vector prefix.
 void setExtent(int envType, Object extentProvider, Object snapRasterData)
          Sets the type and values of extent in the RasterAnalysis.
 void setMaskByRef(IGeoDataset mask)
          Mask allows processing to occur only for a selected set of cells.
 void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
          The output spatial reference of GeoAnalysis.
 void setOutWorkspaceByRef(IWorkspace workspace)
          The output workspace of GeoAnalysis.
 void setVerifyType(int verifyType)
          The verify type of the RasterAnalysis.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

RasterMultivariateOp

public RasterMultivariateOp()
                     throws IOException,
                            UnknownHostException
Constructs a RasterMultivariateOp using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RasterMultivariateOp

public RasterMultivariateOp(Object obj)
                     throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterMultivariateOp theRasterMultivariateOp = (RasterMultivariateOp) obj;

Construct a RasterMultivariateOp using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterMultivariateOp.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setCellSize

public void setCellSize(int envType,
                        Object cellSizeProvider)
                 throws IOException,
                        AutomationException
Sets the type and value of cell size in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster cellsize environment settings for analysis. All subsequent results will be to the value specified. It can be of type

esriRasterEnvMaxOf – The largest cell size of all input raster datasets that are specifed in the function. This is the default.

This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead.

esriRasterEnvMinOf - Smallest cell size of all input raster datasets.

This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead

esriRasterEnvValue - Any user specified value for the cell size.

Use this option to specify a particular value for a cell size or for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only input.

[cellSizeProvider]

A specified value (double) or RasterDataset that is used to provide the cellsize environment value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCellSize in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)
cellSizeProvider - A Variant (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellSize

public void getCellSize(int[] envType,
                        double[] cellSize)
                 throws IOException,
                        AutomationException
Gets the type and value of cell size in the RasterAnalysis.

Remarks

envType

will return an enumeration type constant specifying the raster cellsize environment settings for analysis. It can be of type

esriRasterEnvMaxOf - largest cell size of all input datasets. This is the default.

esriRasterEnvMinOf - smallest cell size of all input datasets

esriRasterEnvValue - User specified value.

cellsize

returns a value that specifying the current environment setting for cellsize

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCellSize in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)
cellSize - The cellSize (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(int envType,
                      Object extentProvider,
                      Object snapRasterData)
               throws IOException,
                      AutomationException
Sets the type and values of extent in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster extent environment settings for analysis. All subsequent results will be to this extent. It can be of type

esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default.

esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used.

esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

[extentProvider]

An envelope object supporting IEnvelope interface or RasterDataset that is used to provide the environment values of the analysis extent.

[snapRasterData]

A RasterDataset that can be used to snap all output raster datasets to the cell registration of the specified raster. All subsequent results will share the lower-left corner and cell size of the specified raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExtent in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)
extentProvider - A Variant (in, optional, pass null if not required)
snapRasterData - A Variant (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(int[] envType,
                      IEnvelope[] extent)
               throws IOException,
                      AutomationException
Gets the type and values of extent in the RasterAnalysis.

Remarks

envType

will return an enumeration constant specifying the raster extent environment settings for analysis. It can be of type,

esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default.

esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used.

esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

extent

An envelope object supporting IEnvelope interface used to describe the values of the analysis extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskByRef

public void setMaskByRef(IGeoDataset mask)
                  throws IOException,
                         AutomationException
Mask allows processing to occur only for a selected set of cells.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaskByRef in interface IRasterAnalysisEnvironment
Parameters:
mask - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMask

public IGeoDataset getMask()
                    throws IOException,
                           AutomationException
Mask allows processing to occur only for a selected set of cells.

Remarks

The mask can be a reference to a Raster, RasterDataset, RasterBand, or RasterDescriptor object or FeatureClass, FeatureClassDescriptor object.

The mask identifies only those cells within the analysis extent that will be considered when performing an action. Only the identified cells will be processed in subsequent output raster datasets. All other cells are characterized as nodata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMask in interface IRasterAnalysisEnvironment
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.

setVerifyType

public void setVerifyType(int verifyType)
                   throws IOException,
                          AutomationException
The verify type of the RasterAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVerifyType in interface IRasterAnalysisEnvironment
Parameters:
verifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVerifyType

public int getVerifyType()
                  throws IOException,
                         AutomationException
The verify type of the RasterAnalysis.

Remarks

The value is an enumeration environment setting that contols the way that an output RasterDatasets are written to file when during analysis. The verify enumeration can be of type

esriRasterEnvVerifyOn - specifies that the user will be prompted to verify the output already exists and it is okay to overwrite it

esriRasterEnvVerifyOff - specifies that output data will be automatically overwritten if already exists. This is the default environment setting.

esriRasterEnvVerifyError - specifies that an error will be produced when the output already exists.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVerifyType in interface IRasterAnalysisEnvironment
Returns:
A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

public String getDefaultOutputRasterPrefix()
                                    throws IOException,
                                           AutomationException
The default output raster prefix.

Remarks

The user specified prefix which is included to all temporary output RasterDatasets during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment
Returns:
The rasterPrefix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

public void setDefaultOutputRasterPrefix(String rasterPrefix)
                                  throws IOException,
                                         AutomationException
The default output raster prefix.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment
Parameters:
rasterPrefix - The rasterPrefix (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

public String getDefaultOutputVectorPrefix()
                                    throws IOException,
                                           AutomationException
The default output vector prefix.

Remarks

The user specified prefix which is included to all temporary output Shapefiles during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment
Returns:
The vectorPrefix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

public void setDefaultOutputVectorPrefix(String vectorPrefix)
                                  throws IOException,
                                         AutomationException
The default output vector prefix.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment
Parameters:
vectorPrefix - The vectorPrefix (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

public void setAsNewDefaultEnvironment()
                                throws IOException,
                                       AutomationException
Sets the raster analysis environment of the object as new default environment.

Remarks

Will set all current environment settings of the RasterAnalysis object as the new default environment. All subsequent analysis will use the set object properties unless otherwise specified.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

public void restoreToPreviousDefaultEnvironment()
                                         throws IOException,
                                                AutomationException
Restores to the previous default raster analysis environment.

Remarks

This will restore the default environment to the settings of the "previous" RasterAnalysisEnvironment object used to set the default environement. Note: If multiple default environments have been set it will reference the past settings one at a time in order of sequence.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Remove all previously stored default rasteranalysis environments.

Remarks

This method can be used to restore the system default raster environment settings for extent, cell size, precision, spatial reference and/or current workspace for analysis. This will change all previously altered environment settings made to the RasterAnlaysis object back to the original settings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
reset in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws IOException,
                                 AutomationException
The output workspace of GeoAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOutWorkspaceByRef in interface IGeoAnalysisEnvironment
Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws IOException,
                                  AutomationException
The output workspace of GeoAnalysis.

Remarks

The variable is an object specifying the directory or subdirectory to contain the output rasterdataset

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOutWorkspace in interface IGeoAnalysisEnvironment
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws IOException,
                                        AutomationException
The output spatial reference of GeoAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws IOException,
                                                AutomationException
The output spatial reference of GeoAnalysis.

Remarks

The variable references an object that specifies the output features spatial reference. If not explicitly set the spatial reference of the input features will be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOutSpatialReference in interface IGeoAnalysisEnvironment
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

classProbability

public 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

Specified by:
classProbability in interface IMultivariateOp
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

public 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

Specified by:
createSignatures in interface IMultivariateOp
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

public 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

Specified by:
dendrogram in interface IMultivariateOp
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

public 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

Specified by:
editSignatures in interface IMultivariateOp
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

public 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

Specified by:
isoCluster in interface IMultivariateOp
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

public 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

Specified by:
mLClassify in interface IMultivariateOp
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

public 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

Specified by:
principalComponents in interface IMultivariateOp
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

public 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

Specified by:
bandCollectionStats in interface IMultivariateOp
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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.