com.esri.arcgis.datasourcesraster
Interface IHistogramSpecification

All Superinterfaces:

Serializable

All Known Implementing Classes:

HistogramSpecification

public interface IHistogramSpecification
extends Serializable

Provides access to members that control histogram specification.

Product Availability

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

Method Summary

IArray	getInputHistogram() The collection of histograms that describe the distribution of input values.
Object	getLookup(int iBand) Returns the look-up array for the requested band for remapping pixel values.
IArray	getTargetHistogram() The collection of target histograms that describe the desired distribution of output values.
void	setInputHistogramByRef(IArray ppInputHistograms) The collection of histograms that describe the distribution of input values.
void	setTargetHistogramByRef(IArray ppTargetHistograms) The collection of target histograms that describe the desired distribution of output values.
void	update() Recalculates the look-up that maps input values -- having a distribution described by the input histograms -- to output values that have a distribution described by the target histograms.

Method Detail

setInputHistogramByRef

void setInputHistogramByRef(IArray ppInputHistograms)
                            throws IOException,
                                   AutomationException

The collection of histograms that describe the distribution of input values.

Product Availability

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

Parameters:

ppInputHistograms - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputHistogram

IArray getInputHistogram()
                         throws IOException,
                                AutomationException

The collection of histograms that describe the distribution of input values.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetHistogramByRef

void setTargetHistogramByRef(IArray ppTargetHistograms)
                             throws IOException,
                                    AutomationException

The collection of target histograms that describe the desired distribution of output values. These are the histograms to which each input histogram is matched.

Product Availability

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

Parameters:

ppTargetHistograms - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetHistogram

IArray getTargetHistogram()
                          throws IOException,
                                 AutomationException

The collection of target histograms that describe the desired distribution of output values. These are the histograms to which each input histogram is matched.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

void update()
            throws IOException,
                   AutomationException

Recalculates the look-up that maps input values -- having a distribution described by the input histograms -- to output values that have a distribution described by the target histograms.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLookup

Object getLookup(int iBand)
                 throws IOException,
                        AutomationException

Returns the look-up array for the requested band for remapping pixel values.

Product Availability

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

Parameters:

iBand - The iBand (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.