|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.datasourcesraster.StatsHistogram
public class StatsHistogram
A raster statistics and histogram class.
StatsHistogram is a helper object that provides the statistics and histogram of a raster for the RasterStretchColorRampRenderer and the RasterRGBRenderer objects. The statistics and histogram can be created either from scratch by using this object, or by using RasterCalcStatsHistogram object.
Constructor Summary | |
---|---|
StatsHistogram()
Constructs a StatsHistogram using ArcGIS Engine. |
|
StatsHistogram(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. StatsHistogram theStatsHistogram = (StatsHistogram) obj; |
Method Summary | |
---|---|
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(Object o)
Compare this object with another |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
Object |
getCovariances()
Array of doubles, the covariances with the n bands of the raster. |
Object |
getHistogram()
The histogram values of the statistics. |
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 |
putHistogramInfo(int size,
double resolution,
double min,
double max)
Sets histogram size, min and 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[] min,
double[] max)
Gets histogram size, min and 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(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setCovariances(Object pVal)
Array of doubles, the covariances with the n bands of the raster. |
void |
setHistogram(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(ObjectOutput out)
|
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 |
---|
public StatsHistogram() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic StatsHistogram(Object obj) throws IOException
StatsHistogram theStatsHistogram = (StatsHistogram) obj;
obj
to StatsHistogram
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public double getMin() throws IOException, AutomationException
getMin
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMin(double min) throws IOException, AutomationException
setMin
in interface IStatsHistogram
min
- The min (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMax() throws IOException, AutomationException
getMax
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMax(double max) throws IOException, AutomationException
setMax
in interface IStatsHistogram
max
- The max (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMean() throws IOException, AutomationException
getMean
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMean(double mean) throws IOException, AutomationException
setMean
in interface IStatsHistogram
mean
- The mean (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getStdDev() throws IOException, AutomationException
getStdDev
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStdDev(double stdDev) throws IOException, AutomationException
setStdDev
in interface IStatsHistogram
stdDev
- The stdDev (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void putHistogramMinmax(double min, double max) throws IOException, AutomationException
putHistogramMinmax
in interface IStatsHistogram
min
- The min (in)max
- The max (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryHistogramMinmax(double[] min, double[] max) throws IOException, AutomationException
queryHistogramMinmax
in interface IStatsHistogram
min
- The min (out: use single element array)max
- The max (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getHistogram() throws IOException, AutomationException
This method returns a single dimensional array of value of size 256. Each value in the array is the normalized count of pixels in the specific bin.
The pixel values in the raster, if they are beyond 0-255, will be binned (or reclassfied) to 0-255.
getHistogram
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHistogram(Object histogram) throws IOException, AutomationException
setHistogram
in interface IStatsHistogram
histogram
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void putStats(double min, double max, double mean, double stdDev) throws IOException, AutomationException
putStats
in interface IStatsHistogram
min
- The min (in)max
- The max (in)mean
- The mean (in)stdDev
- The stdDev (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryStats(double[] min, double[] max, double[] mean, double[] stdDev) throws IOException, AutomationException
queryStats
in interface IStatsHistogram
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void empty() throws IOException, AutomationException
empty
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean hasStats() throws IOException, AutomationException
hasStats
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean hasHistogram() throws IOException, AutomationException
hasHistogram
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void accumulate(double value, int count) throws IOException, AutomationException
accumulate
in interface IStatsHistogram
value
- The value (in)count
- The count (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void update() throws IOException, AutomationException
update
in interface IStatsHistogram
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getPixelCount() throws IOException, AutomationException
getPixelCount
in interface IStatsHistogram2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void putHistogramInfo(int size, double resolution, double min, double max) throws IOException, AutomationException
putHistogramInfo
in interface IStatsHistogram3
size
- The size (in)resolution
- The resolution (in)min
- The min (in)max
- The max (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryHistogramInfo(int[] size, double[] resolution, double[] min, double[] max) throws IOException, AutomationException
queryHistogramInfo
in interface IStatsHistogram3
size
- The size (out: use single element array)resolution
- The resolution (out: use single element array)min
- The min (out: use single element array)max
- The max (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterStatistics getRasterStatistics() throws IOException, AutomationException
getRasterStatistics
in interface IStatsHistogram3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterHistogram getRasterHistogram() throws IOException, AutomationException
getRasterHistogram
in interface IStatsHistogram3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void initCovariances(int nBands) throws IOException, AutomationException
initCovariances
in interface IStatsHistogram3
nBands
- The nBands (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void accumulateCovariance(int iBand, double numValidPixel, double xy, double x, double y) throws IOException, AutomationException
accumulateCovariance
in interface IStatsHistogram3
iBand
- The iBand (in)numValidPixel
- The numValidPixel (in)xy
- The xy (in)x
- The x (in)y
- The y (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void updateCovariances() throws IOException, AutomationException
updateCovariances
in interface IStatsHistogram3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getCovariances() throws IOException, AutomationException
getCovariances
in interface IStatsHistogram3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCovariances(Object pVal) throws IOException, AutomationException
setCovariances
in interface IStatsHistogram3
pVal
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |