com.esri.arcgis.datasourcesraster
Interface IStatsHistogram

All Superinterfaces:
Serializable
All Known Implementing Classes:
StatsHistogram

public interface IStatsHistogram
extends Serializable

Provides access to members that controls stats and histogram.

Remarks

IStatsHistogram, the interface for StatsHistogram , is used to access the statistics and bin histogram.

StatsHistogram can be created from RasterCalcStatsHistogram and is used to set the raster stretch (using IRasterStretch2) for RasterStretchColorRampRenderer

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void accumulate(double value, int count)
          Accumulates a value and its count.
 void empty()
          Empties this RasterStatsHistogram and marks it invalid.
 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 getStdDev()
          The standard deviation value of the historgram.
 boolean hasHistogram()
          Checks if this StatsHistogram has histogram.
 boolean hasStats()
          Checks if this StatsHistogram has stats.
 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 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 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.
 

Method Detail

getMin

double getMin()
              throws IOException,
                     AutomationException
The minimum value of the historgram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The min
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMin

void setMin(double min)
            throws IOException,
                   AutomationException
The minimum value of the historgram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
min - The min (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMax

double getMax()
              throws IOException,
                     AutomationException
The maximum value of the historgram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The max
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMax

void setMax(double max)
            throws IOException,
                   AutomationException
The maximum value of the historgram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
max - The max (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMean

double getMean()
               throws IOException,
                      AutomationException
The mean value of the historgram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The mean
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMean

void setMean(double mean)
             throws IOException,
                    AutomationException
The mean value of the historgram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
mean - The mean (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStdDev

double getStdDev()
                 throws IOException,
                        AutomationException
The standard deviation value of the historgram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The stdDev
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStdDev

void setStdDev(double stdDev)
               throws IOException,
                      AutomationException
The standard deviation value of the historgram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
stdDev - The stdDev (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putHistogramMinmax

void putHistogramMinmax(double min,
                        double max)
                        throws IOException,
                               AutomationException
Sets histogram min and max range.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
min - The min (in)
max - The max (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryHistogramMinmax

void queryHistogramMinmax(double[] min,
                          double[] max)
                          throws IOException,
                                 AutomationException
Gets histogram min and max range.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
min - The min (out: use single element array)
max - The max (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHistogram

Object getHistogram()
                    throws IOException,
                           AutomationException
The histogram values of the statistics.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHistogram

void setHistogram(Object histogram)
                  throws IOException,
                         AutomationException
The histogram values of the statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
histogram - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putStats

void putStats(double min,
              double max,
              double mean,
              double stdDev)
              throws IOException,
                     AutomationException
Computes stats and histogram from a given Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
min - The min (in)
max - The max (in)
mean - The mean (in)
stdDev - The stdDev (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryStats

void queryStats(double[] min,
                double[] max,
                double[] mean,
                double[] stdDev)
                throws IOException,
                       AutomationException
Computes stats and histogram from a given Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

void empty()
           throws IOException,
                  AutomationException
Empties this RasterStatsHistogram and marks it invalid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasStats

boolean hasStats()
                 throws IOException,
                        AutomationException
Checks if this StatsHistogram has stats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The b
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasHistogram

boolean hasHistogram()
                     throws IOException,
                            AutomationException
Checks if this StatsHistogram has histogram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The b
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

accumulate

void accumulate(double value,
                int count)
                throws IOException,
                       AutomationException
Accumulates a value and its count.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
value - The value (in)
count - The count (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

void update()
            throws IOException,
                   AutomationException
Updates the histogram after accumulation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.