com.esri.arcgis.datasourcesraster
Class RasterHistogram

java.lang.Object
  com.esri.arcgis.datasourcesraster.RasterHistogram

All Implemented Interfaces:

IRasterHistogram, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterHistogram
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterHistogram

A raster histogram class.

Remarks

An object used to manage the histogram of the raster pixels. It can be retrieved from a RasterBand.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterHistogram()
Constructs a RasterHistogram using ArcGIS Engine.

RasterHistogram(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterHistogram theRasterHistogram = (RasterHistogram) obj;

Method Summary

int	bin(double pixval) Translates pixel values to integer Bin index.
boolean	equals(Object o) Compare this object with another
IBinFunction	getBinFunction() The Bin function that maps pixel value into histogram index.
static String	getClsid() getClsid.
Object	getCounts() Count array in doubles.
int	hashCode() the hashcode for this object
void	setCounts(Object pVal) Count array in doubles.

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

RasterHistogram

public RasterHistogram()
                throws IOException,
                       UnknownHostException

Constructs a RasterHistogram using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterHistogram

public RasterHistogram(Object obj)
                throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getCounts

public 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

Specified by:

getCounts in interface IRasterHistogram

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCounts

public 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

Specified by:

setCounts in interface IRasterHistogram

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bin

public 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

Specified by:

bin in interface IRasterHistogram

Parameters:

pixval - The pixval (in)

Returns:

The bin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinFunction

public 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

Specified by:

getBinFunction in interface IRasterHistogram

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.