com.esri.arcgis.datasourcesraster
Class HistogramSpecification

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

All Implemented Interfaces:

IHistogramSpecification, IPixelFilter, IStockFrequencyDistributionHistogram, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class HistogramSpecification
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IHistogramSpecification, IStockFrequencyDistributionHistogram, IPixelFilter

COM Class 'HistogramSpecification'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'A class for histogram specification.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesraster.IHistogramSpecification

IID, IID978bbc66_4461_44bc_a068_0572a7f2d828, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IStockFrequencyDistributionHistogram

IID, IIDea83381d_c3a8_4677_931e_62671af63b19, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelFilter

IID, IID90e3de9d_4fff_4575_b833_3ad29a57eeca, xxDummy

Constructor Summary

HistogramSpecification()
Constructs a HistogramSpecification using ArcGIS Engine.

HistogramSpecification(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HistogramSpecification theHistogramSpecification = (HistogramSpecification) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
void	filter(IPixelBlock pBlock) Filters a pixel block.
void	getCenterPosition(int[] atColumn, int[] atRow) Gets center position of the filter.
static java.lang.String	getClsid() getClsid.
IArray	getInputHistogram() The collection of histograms that describe the distribution of input values.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.Object	getLookup(int iBand) Returns the look-up array for the requested band for remapping pixel values.
IRasterHistogram	getNormalDistribution(int nBins, double mean, double stdDev) Returns a histogram containing a specified number of bins describing a normal/gaussian distribution with a specified mean and standard deviation.
void	getSize(int[] columns, int[] rows) Gets dimension of the filter.
IArray	getTargetHistogram() The collection of target histograms that describe the desired distribution of output values.
IRasterHistogram	getUniformDistribution(int nBins) Returns a histogram containing a specified number of bins describing a uniform distribution.
int	hashCode() the hashcode for this object
void	release() Release a HistogramSpecification.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistogramSpecification

public HistogramSpecification()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a HistogramSpecification using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

HistogramSpecification

public HistogramSpecification(java.lang.Object obj)
                       throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a HistogramSpecification.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setInputHistogramByRef

public void setInputHistogramByRef(IArray ppInputHistograms)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

setInputHistogramByRef in interface IHistogramSpecification

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputHistogram

public IArray getInputHistogram()
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

getInputHistogram in interface IHistogramSpecification

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetHistogramByRef

public void setTargetHistogramByRef(IArray ppTargetHistograms)
                             throws java.io.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.

Specified by:

setTargetHistogramByRef in interface IHistogramSpecification

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetHistogram

public IArray getTargetHistogram()
                          throws java.io.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.

Specified by:

getTargetHistogram in interface IHistogramSpecification

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws java.io.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.

Specified by:

update in interface IHistogramSpecification

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLookup

public java.lang.Object getLookup(int iBand)
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

getLookup in interface IHistogramSpecification

Parameters:

iBand - The iBand (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormalDistribution

public IRasterHistogram getNormalDistribution(int nBins,
                                              double mean,
                                              double stdDev)
                                       throws java.io.IOException,
                                              AutomationException

Returns a histogram containing a specified number of bins describing a normal/gaussian distribution with a specified mean and standard deviation.

Specified by:

getNormalDistribution in interface IStockFrequencyDistributionHistogram

Parameters:

nBins - The nBins (in)

mean - The mean (in)

stdDev - The stdDev (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniformDistribution

public IRasterHistogram getUniformDistribution(int nBins)
                                        throws java.io.IOException,
                                               AutomationException

Returns a histogram containing a specified number of bins describing a uniform distribution.

Specified by:

getUniformDistribution in interface IStockFrequencyDistributionHistogram

Parameters:

nBins - The nBins (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSize

public void getSize(int[] columns,
                    int[] rows)
             throws java.io.IOException,
                    AutomationException

Gets dimension of the filter.

Specified by:

getSize in interface IPixelFilter

Parameters:

columns - The columns (in/out: use single element array)

rows - The rows (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterPosition

public void getCenterPosition(int[] atColumn,
                              int[] atRow)
                       throws java.io.IOException,
                              AutomationException

Gets center position of the filter.

Specified by:

getCenterPosition in interface IPixelFilter

Parameters:

atColumn - The atColumn (in/out: use single element array)

atRow - The atRow (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

filter

public void filter(IPixelBlock pBlock)
            throws java.io.IOException,
                   AutomationException

Filters a pixel block.

Specified by:

filter in interface IPixelFilter

Parameters:

pBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.