com.esri.arcgis.datasourcesraster
Interface IRasterStatistics

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterStatistics

public interface IRasterStatistics
extends Serializable

Provides access to members that control raster statistics.

Remarks

The RasterStatistics class is not cocreatable and must be retrieved from a RasterBand object. The statistics only provide information about a single band and are used when displaying the raster. The statistics may be modified or recalculated using this object.

Statistics can be calculated by setting a skip factor to avoid calculating on a full raster. Although the statitics calculated this way is not true statstics of the raster, it can reduce the calculating time significantly for large images without noticeable decreasing of the display quality.

Product Availability

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

Method Summary

Object	getIgnoredValues() Array of doubles indicating the pixel values not included in the statistics calculation.
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.
boolean	isValid() Indicates if statistics are fresh.
void	recalculate() Recalculate statistics based upon current skip factors and ignored values.
void	setIgnoredValues(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.

Method Detail

getMinimum

double getMinimum()
                  throws IOException,
                         AutomationException

Approximate smallest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimum

void setMinimum(double pVal)
                throws IOException,
                       AutomationException

Approximate smallest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximum

double getMaximum()
                  throws IOException,
                         AutomationException

Approximate largest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximum

void setMaximum(double pVal)
                throws IOException,
                       AutomationException

Approximate largest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMean

double getMean()
               throws IOException,
                      AutomationException

Approximate average value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMean

void setMean(double pVal)
             throws IOException,
                    AutomationException

Approximate average value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardDeviation

double getStandardDeviation()
                            throws IOException,
                                   AutomationException

Measures spread of pixel values about the mean.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardDeviation

void setStandardDeviation(double pVal)
                          throws IOException,
                                 AutomationException

Measures spread of pixel values about the mean.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMedian

double getMedian()
                 throws IOException,
                        AutomationException

Divides pixel population approximately in halves.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMode

double getMode()
               throws IOException,
                      AutomationException

Approximate most popular pixel value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
                throws IOException,
                       AutomationException

Indicates if statistics are fresh.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsValid

void setIsValid(boolean pVal)
                throws IOException,
                       AutomationException

Indicates if statistics are fresh.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIgnoredValues

Object getIgnoredValues()
                        throws IOException,
                               AutomationException

Array of doubles indicating the pixel values not included in the statistics calculation.

Remarks

The ignore value is ignored if calculating statistics on a grid.

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.

setIgnoredValues

void setIgnoredValues(Object pVal)
                      throws IOException,
                             AutomationException

Array of doubles indicating the pixel values not included in the statistics calculation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSkipFactorX

int getSkipFactorX()
                   throws IOException,
                          AutomationException

Number of horizontal pixels between samples for purposes of calculating statistics.

Remarks

The skip factor is ignored, always use 1, if calculating statistics on a grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSkipFactorX

void setSkipFactorX(int pVal)
                    throws IOException,
                           AutomationException

Number of horizontal pixels between samples for purposes of calculating statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSkipFactorY

int getSkipFactorY()
                   throws IOException,
                          AutomationException

Number of vertical pixels between samples for purposes of calculating statistics.

Remarks

The skip factor is ignored, always use 1, if calculating statistics on a grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSkipFactorY

void setSkipFactorY(int pVal)
                    throws IOException,
                           AutomationException

Number of vertical pixels between samples for purposes of calculating statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterBand

void setRasterBand(IRasterBand rhs1)
                   throws IOException,
                          AutomationException

The RasterBand.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

recalculate

void recalculate()
                 throws IOException,
                        AutomationException

Recalculate statistics based upon current skip factors and ignored values.

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.