com.esri.arcgis.datasourcesraster

Class StatsHistogram

java.lang.Object

com.esri.arcgis.datasourcesraster.StatsHistogram

All Implemented Interfaces:

IStatsHistogram, IStatsHistogram2, IStatsHistogram3, IStatsHistogram4, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class StatsHistogram
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IStatsHistogram, IStatsHistogram2, IStatsHistogram3, IStatsHistogram4, IPersist, IPersistStream, java.io.Externalizable

COM Class 'StatsHistogram'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A raster statistics and histogram 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

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.datasourcesraster.IStatsHistogram4

IID, IID620b3f79_6b77_4273_8825_cf2b029431eb, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IStatsHistogram3

IIDdbe269bf_6bde_43f2_9bfb_d90551d7efe3

Fields inherited from interface com.esri.arcgis.datasourcesraster.IStatsHistogram2

IID0a69bfa0_d411_468d_be27_3042e80a9cc0

Fields inherited from interface com.esri.arcgis.datasourcesraster.IStatsHistogram

IID2b9062e8_df44_4012_a0e4_cf0efaa21693

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

Constructors

Constructor and Description
StatsHistogram() Constructs a StatsHistogram using ArcGIS Engine.
StatsHistogram(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. StatsHistogram theStatsHistogram = (StatsHistogram) obj;

Method Summary

Modifier and Type	Method and Description
void	accumulate(double value, int count) Accumulates a value and its count.
void	accumulateCovariance(int iBand, double numValidPixel, double xy, double x, double y) Accumulates covariance array, numValidPixel.
void	empty() Empties this RasterStatsHistogram and marks it invalid.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
void	getCovarAccu(int iBand, double[] numValidPixel, double[] covarXY, double[] meanX, double[] meanY) Get the accumulating or running variables used for covar computation.
java.lang.Object	getCovariances() Array of doubles, the covariances with the n bands of the raster.
java.lang.Object	getHistogram() The histogram values of the statistics.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
double	getMax() The maximum value of the historgram.
double	getMean() The mean value of the historgram.
double	getMin() The minimum value of the historgram.
double	getPixelCount() The total pixel count.
IRasterHistogram	getRasterHistogram() The raster histogram.
IRasterStatistics	getRasterStatistics() The raster statistics.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getStdDev() The standard deviation value of the historgram.
int	hashCode() the hashcode for this object
boolean	hasHistogram() Checks if this StatsHistogram has histogram.
boolean	hasStats() Checks if this StatsHistogram has stats.
void	initCovariances(int nBands) Resizes covariance array to nBands, init all elements to 0.
void	isDirty() isDirty
void	load(IStream pstm) load
void	putCovarAccu(int iBand, double numValidPixel, double covarXY, double meanX, double meanY) Put the accumulating or running variables used for covar computation.
void	putHistogramInfo(int size, double resolution, double minh, double maxh) Sets histogram size, resolution, and min/max range.
void	putHistogramMinmax(double min, double max) Sets histogram min and max range.
void	putStats(double min, double max, double mean, double stdDev) Computes stats and histogram from a given Raster.
void	queryHistogramInfo(int[] size, double[] resolution, double[] minh, double[] maxh) Gets histogram size, resolutiom, and min/max range.
void	queryHistogramMinmax(double[] min, double[] max) Gets histogram min and max range.
void	queryStats(double[] min, double[] max, double[] mean, double[] stdDev) Computes stats and histogram from a given Raster.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	setCovariances(java.lang.Object pVal) Array of doubles, the covariances with the n bands of the raster.
void	setHistogram(java.lang.Object histogram) The histogram values of the statistics.
void	setMax(double max) The maximum value of the historgram.
void	setMean(double mean) The mean value of the historgram.
void	setMin(double min) The minimum value of the historgram.
void	setStdDev(double stdDev) The standard deviation value of the historgram.
void	update() Updates the histogram after accumulation.
void	updateCovariances() Final update after accumulate is finished.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

StatsHistogram

public StatsHistogram()
               throws java.io.IOException,
                      java.net.UnknownHostException

Constructs a StatsHistogram using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

StatsHistogram

public StatsHistogram(java.lang.Object obj)
               throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StatsHistogram theStatsHistogram = (StatsHistogram) obj;

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getMin

public double getMin()
              throws java.io.IOException,
                     AutomationException

The minimum value of the historgram.

Specified by:

getMin in interface IStatsHistogram

Returns:

The min

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMin

public void setMin(double min)
            throws java.io.IOException,
                   AutomationException

The minimum value of the historgram.

Specified by:

setMin in interface IStatsHistogram

Parameters:

min - The min (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMax

public double getMax()
              throws java.io.IOException,
                     AutomationException

The maximum value of the historgram.

Specified by:

getMax in interface IStatsHistogram

Returns:

The max

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMax

public void setMax(double max)
            throws java.io.IOException,
                   AutomationException

The maximum value of the historgram.

Specified by:

setMax in interface IStatsHistogram

Parameters:

max - The max (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

The mean value of the historgram.

Specified by:

getMean in interface IStatsHistogram

Returns:

The mean

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMean

public void setMean(double mean)
             throws java.io.IOException,
                    AutomationException

The mean value of the historgram.

Specified by:

setMean in interface IStatsHistogram

Parameters:

mean - The mean (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStdDev

public double getStdDev()
                 throws java.io.IOException,
                        AutomationException

The standard deviation value of the historgram.

Specified by:

getStdDev in interface IStatsHistogram

Returns:

The stdDev

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStdDev

public void setStdDev(double stdDev)
               throws java.io.IOException,
                      AutomationException

The standard deviation value of the historgram.

Specified by:

setStdDev in interface IStatsHistogram

Parameters:

stdDev - The stdDev (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putHistogramMinmax

public void putHistogramMinmax(double min,
                               double max)
                        throws java.io.IOException,
                               AutomationException

Sets histogram min and max range.

Specified by:

putHistogramMinmax in interface IStatsHistogram

Parameters:

min - The min (in)

max - The max (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryHistogramMinmax

public void queryHistogramMinmax(double[] min,
                                 double[] max)
                          throws java.io.IOException,
                                 AutomationException

Gets histogram min and max range.

Specified by:

queryHistogramMinmax in interface IStatsHistogram

Parameters:

min - The min (out: use single element array)

max - The max (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHistogram

public java.lang.Object getHistogram()
                              throws java.io.IOException,
                                     AutomationException

The histogram values of the statistics.

Specified by:

getHistogram in interface IStatsHistogram

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHistogram

public void setHistogram(java.lang.Object histogram)
                  throws java.io.IOException,
                         AutomationException

The histogram values of the statistics.

Specified by:

setHistogram in interface IStatsHistogram

Parameters:

histogram - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putStats

public void putStats(double min,
                     double max,
                     double mean,
                     double stdDev)
              throws java.io.IOException,
                     AutomationException

Computes stats and histogram from a given Raster.

Specified by:

putStats in interface IStatsHistogram

Parameters:

min - The min (in)

max - The max (in)

mean - The mean (in)

stdDev - The stdDev (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryStats

public void queryStats(double[] min,
                       double[] max,
                       double[] mean,
                       double[] stdDev)
                throws java.io.IOException,
                       AutomationException

Computes stats and histogram from a given Raster.

Specified by:

queryStats in interface IStatsHistogram

Parameters:

min - The min (out: use single element array)

max - The max (out: use single element array)

mean - The mean (out: use single element array)

stdDev - The stdDev (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws java.io.IOException,
                  AutomationException

Empties this RasterStatsHistogram and marks it invalid.

Specified by:

empty in interface IStatsHistogram

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasStats

public boolean hasStats()
                 throws java.io.IOException,
                        AutomationException

Checks if this StatsHistogram has stats.

Specified by:

hasStats in interface IStatsHistogram

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasHistogram

public boolean hasHistogram()
                     throws java.io.IOException,
                            AutomationException

Checks if this StatsHistogram has histogram.

Specified by:

hasHistogram in interface IStatsHistogram

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

accumulate

public void accumulate(double value,
                       int count)
                throws java.io.IOException,
                       AutomationException

Accumulates a value and its count.

Specified by:

accumulate in interface IStatsHistogram

Parameters:

value - The value (in)

count - The count (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws java.io.IOException,
                   AutomationException

Updates the histogram after accumulation.

Specified by:

update in interface IStatsHistogram

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelCount

public double getPixelCount()
                     throws java.io.IOException,
                            AutomationException

The total pixel count.

Specified by:

getPixelCount in interface IStatsHistogram2

Returns:

The pNumPixels

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putHistogramInfo

public void putHistogramInfo(int size,
                             double resolution,
                             double minh,
                             double maxh)
                      throws java.io.IOException,
                             AutomationException

Sets histogram size, resolution, and min/max range.

Specified by:

putHistogramInfo in interface IStatsHistogram3

Parameters:

size - The size (in)

resolution - The resolution (in)

minh - The minh (in)

maxh - The maxh (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryHistogramInfo

public void queryHistogramInfo(int[] size,
                               double[] resolution,
                               double[] minh,
                               double[] maxh)
                        throws java.io.IOException,
                               AutomationException

Gets histogram size, resolutiom, and min/max range.

Specified by:

queryHistogramInfo in interface IStatsHistogram3

Parameters:

size - The size (out: use single element array)

resolution - The resolution (out: use single element array)

minh - The minh (out: use single element array)

maxh - The maxh (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterStatistics

public IRasterStatistics getRasterStatistics()
                                      throws java.io.IOException,
                                             AutomationException

The raster statistics.

Specified by:

getRasterStatistics in interface IStatsHistogram3

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterStatistics

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterHistogram

public IRasterHistogram getRasterHistogram()
                                    throws java.io.IOException,
                                           AutomationException

The raster histogram.

Specified by:

getRasterHistogram in interface IStatsHistogram3

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterHistogram

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initCovariances

public void initCovariances(int nBands)
                     throws java.io.IOException,
                            AutomationException

Resizes covariance array to nBands, init all elements to 0.

Specified by:

initCovariances in interface IStatsHistogram3

Parameters:

nBands - The nBands (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

accumulateCovariance

public void accumulateCovariance(int iBand,
                                 double numValidPixel,
                                 double xy,
                                 double x,
                                 double y)
                          throws java.io.IOException,
                                 AutomationException

Accumulates covariance array, numValidPixel.

Specified by:

accumulateCovariance in interface IStatsHistogram3

Parameters:

iBand - The iBand (in)

numValidPixel - The numValidPixel (in)

xy - The xy (in)

x - The x (in)

y - The y (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateCovariances

public void updateCovariances()
                       throws java.io.IOException,
                              AutomationException

Final update after accumulate is finished.

Specified by:

updateCovariances in interface IStatsHistogram3

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 IStatsHistogram3

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 IStatsHistogram3

Parameters:

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCovarAccu

public void getCovarAccu(int iBand,
                         double[] numValidPixel,
                         double[] covarXY,
                         double[] meanX,
                         double[] meanY)
                  throws java.io.IOException,
                         AutomationException

Get the accumulating or running variables used for covar computation. Continue to increment from here.

Specified by:

getCovarAccu in interface IStatsHistogram4

Parameters:

iBand - The iBand (in)

numValidPixel - The numValidPixel (out: use single element array)

covarXY - The covarXY (out: use single element array)

meanX - The meanX (out: use single element array)

meanY - The meanY (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCovarAccu

public void putCovarAccu(int iBand,
                         double numValidPixel,
                         double covarXY,
                         double meanX,
                         double meanY)
                  throws java.io.IOException,
                         AutomationException

Put the accumulating or running variables used for covar computation. Do this after having incremented them.

Specified by:

putCovarAccu in interface IStatsHistogram4

Parameters:

iBand - The iBand (in)

numValidPixel - The numValidPixel (in)

covarXY - The covarXY (in)

meanX - The meanX (in)

meanY - The meanY (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException