com.esri.arcgis.datasourcesraster
Class RasterStatistics

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.RasterStatistics
All Implemented Interfaces:
IRasterStatistics, IRasterStatistics2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RasterStatistics
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterStatistics, IRasterStatistics2

COM Class 'RasterStatistics'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'A raster statistics class.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterStatistics2
IID, IIDdc667a54_7969_4486_aa5a_f7ec40d4b707, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterStatistics
IID7e7e6103_fa34_11d1_8d22_0000f8780535
 
Constructor Summary
RasterStatistics()
          Constructs a RasterStatistics using ArcGIS Engine.
RasterStatistics(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterStatistics theRasterStatistics = (RasterStatistics) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 java.lang.Object getCovariances()
          Array of doubles, the covariances with the n bands of the raster.
 java.lang.Object getIgnoredValues()
          Array of doubles indicating the pixel values not included in the statistics calculation.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 double getMaximum()
          Approximate largest value.
 double getMean()
          Approximate average value.
 double getMedian()
          Divides pixel population approximately in halves.
 double getMinimum()
          Approximate smallest value.
 double getMode()
          Approximate most popular pixel value.
 int getSkipFactorX()
          Number of horizontal pixels between samples for purposes of calculating statistics.
 int getSkipFactorY()
          Number of vertical pixels between samples for purposes of calculating statistics.
 double getStandardDeviation()
          Measures spread of pixel values about the mean.
 int hashCode()
          the hashcode for this object
 boolean isValid()
          Indicates if statistics are fresh.
 void recalculate()
          Recalculate statistics based upon current skip factors and ignored values.
 void release()
          Release a RasterStatistics.
 void setCovariances(java.lang.Object pVal)
          Array of doubles, the covariances with the n bands of the raster.
 void setIgnoredValues(java.lang.Object pVal)
          Array of doubles indicating the pixel values not included in the statistics calculation.
 void setIsValid(boolean pVal)
          Indicates if statistics are fresh.
 void setMaximum(double pVal)
          Approximate largest value.
 void setMean(double pVal)
          Approximate average value.
 void setMinimum(double pVal)
          Approximate smallest value.
 void setRasterBand(IRasterBand rhs1)
          The RasterBand.
 void setSkipFactorX(int pVal)
          Number of horizontal pixels between samples for purposes of calculating statistics.
 void setSkipFactorY(int pVal)
          Number of vertical pixels between samples for purposes of calculating statistics.
 void setStandardDeviation(double pVal)
          Measures spread of pixel values about the mean.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RasterStatistics

public RasterStatistics()
                 throws java.io.IOException,
                        java.net.UnknownHostException
Constructs a RasterStatistics using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

RasterStatistics

public RasterStatistics(java.lang.Object obj)
                 throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterStatistics theRasterStatistics = (RasterStatistics) obj;

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

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

getClsid

public static java.lang.String getClsid()
getClsid.


equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a RasterStatistics.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getMinimum

public double getMinimum()
                  throws java.io.IOException,
                         AutomationException
Approximate smallest value.

Specified by:
getMinimum in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimum

public void setMinimum(double pVal)
                throws java.io.IOException,
                       AutomationException
Approximate smallest value.

Specified by:
setMinimum in interface IRasterStatistics
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximum

public double getMaximum()
                  throws java.io.IOException,
                         AutomationException
Approximate largest value.

Specified by:
getMaximum in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximum

public void setMaximum(double pVal)
                throws java.io.IOException,
                       AutomationException
Approximate largest value.

Specified by:
setMaximum in interface IRasterStatistics
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMean

public double getMean()
               throws java.io.IOException,
                      AutomationException
Approximate average value.

Specified by:
getMean in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMean

public void setMean(double pVal)
             throws java.io.IOException,
                    AutomationException
Approximate average value.

Specified by:
setMean in interface IRasterStatistics
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStandardDeviation

public double getStandardDeviation()
                            throws java.io.IOException,
                                   AutomationException
Measures spread of pixel values about the mean.

Specified by:
getStandardDeviation in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStandardDeviation

public void setStandardDeviation(double pVal)
                          throws java.io.IOException,
                                 AutomationException
Measures spread of pixel values about the mean.

Specified by:
setStandardDeviation in interface IRasterStatistics
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMedian

public double getMedian()
                 throws java.io.IOException,
                        AutomationException
Divides pixel population approximately in halves.

Specified by:
getMedian in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMode

public double getMode()
               throws java.io.IOException,
                      AutomationException
Approximate most popular pixel value.

Specified by:
getMode in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException
Indicates if statistics are fresh.

Specified by:
isValid in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsValid

public void setIsValid(boolean pVal)
                throws java.io.IOException,
                       AutomationException
Indicates if statistics are fresh.

Specified by:
setIsValid in interface IRasterStatistics
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIgnoredValues

public java.lang.Object getIgnoredValues()
                                  throws java.io.IOException,
                                         AutomationException
Array of doubles indicating the pixel values not included in the statistics calculation.

Specified by:
getIgnoredValues in interface IRasterStatistics
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIgnoredValues

public void setIgnoredValues(java.lang.Object pVal)
                      throws java.io.IOException,
                             AutomationException
Array of doubles indicating the pixel values not included in the statistics calculation.

Specified by:
setIgnoredValues in interface IRasterStatistics
Parameters:
pVal - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSkipFactorX

public int getSkipFactorX()
                   throws java.io.IOException,
                          AutomationException
Number of horizontal pixels between samples for purposes of calculating statistics.

Specified by:
getSkipFactorX in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSkipFactorX

public void setSkipFactorX(int pVal)
                    throws java.io.IOException,
                           AutomationException
Number of horizontal pixels between samples for purposes of calculating statistics.

Specified by:
setSkipFactorX in interface IRasterStatistics
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSkipFactorY

public int getSkipFactorY()
                   throws java.io.IOException,
                          AutomationException
Number of vertical pixels between samples for purposes of calculating statistics.

Specified by:
getSkipFactorY in interface IRasterStatistics
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSkipFactorY

public void setSkipFactorY(int pVal)
                    throws java.io.IOException,
                           AutomationException
Number of vertical pixels between samples for purposes of calculating statistics.

Specified by:
setSkipFactorY in interface IRasterStatistics
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterBand

public void setRasterBand(IRasterBand rhs1)
                   throws java.io.IOException,
                          AutomationException
The RasterBand.

Specified by:
setRasterBand in interface IRasterStatistics
Parameters:
rhs1 - A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

recalculate

public void recalculate()
                 throws java.io.IOException,
                        AutomationException
Recalculate statistics based upon current skip factors and ignored values.

Specified by:
recalculate in interface IRasterStatistics
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCovariances

public java.lang.Object getCovariances()
                                throws java.io.IOException,
                                       AutomationException
Array of doubles, the covariances with the n bands of the raster.

Specified by:
getCovariances in interface IRasterStatistics2
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCovariances

public void setCovariances(java.lang.Object pVal)
                    throws java.io.IOException,
                           AutomationException
Array of doubles, the covariances with the n bands of the raster.

Specified by:
setCovariances in interface IRasterStatistics2
Parameters:
pVal - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.