com.esri.arcgis.datasourcesraster
Interface IRasterHistogram

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterHistogram

public interface IRasterHistogram
extends Serializable

Provides access to members that control a raster histogram.

Description

IRasterHistogram is used to obtain the histogram of pixel values in a raster band.

Product Availability

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

Method Summary

int	bin(double pixval) Translates pixel values to integer Bin index.
IBinFunction	getBinFunction() The Bin function that maps pixel value into histogram index.
Object	getCounts() Count array in doubles.
void	setCounts(Object pVal) Count array in doubles.

Method Detail

getCounts

Object getCounts()
                 throws IOException,
                        AutomationException

Count array in doubles.

Remarks

This property returns the histogram of the binned pixel values in range 0-255. e.g. an array of 256 and each element is the count.

The pixel values in the raster band will be binned to 0-255 if they are beyond this range.

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.

setCounts

void setCounts(Object pVal)
               throws IOException,
                      AutomationException

Count array in doubles.

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.

bin

int bin(double pixval)
        throws IOException,
               AutomationException

Translates pixel values to integer Bin index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pixval - The pixval (in)

Returns:

The bin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinFunction

IBinFunction getBinFunction()
                            throws IOException,
                                   AutomationException

The Bin function that maps pixel value into histogram index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.