com.esri.arcgis.datasourcesraster

Interface IStretchFunctionArguments

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IStretchFunctionArguments2

All Known Implementing Classes:

IStretchFunctionArguments2Proxy, IStretchFunctionArgumentsProxy, StretchFunctionArguments

public interface IStretchFunctionArguments
extends java.io.Serializable

COM Interface 'IStretchFunctionArguments'. Generated 9/24/2024 11:01:30 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control stretch function arguments.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID3e5a8ca3_6a10_4a3e_a49b_bbc4c86e23fe
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
IDoubleArray	getGamma() The list of Gamma value(s).
IArray	getHistograms() The custom raster stretch histogram.
double	getMax() The current maximum output value.
double	getMaxPercent() The current maximum percent value.
double	getMin() The current minimum output value.
double	getMinPercent() The current minimum percent value.
double	getNumberOfStandardDeviations() The number of standard deviations for standard deviation stretch.
java.lang.Object	getRaster() The source raster object.
IArray	getStatistics() The custom raster stretch statistics.
int	getStretchType() The stretch type.
boolean	isUseGamma() Indicates if applies Gamma stretch.
void	setGammaByRef(IDoubleArray ppGamma) The list of Gamma value(s).
void	setHistogramsByRef(IArray ppHistograms) The custom raster stretch histogram.
void	setMax(double pMaxValue) The current maximum output value.
void	setMaxPercent(double pPercent) The current maximum percent value.
void	setMin(double pMinValue) The current minimum output value.
void	setMinPercent(double pPercent) The current minimum percent value.
void	setNumberOfStandardDeviations(double pNumStdDevs) The number of standard deviations for standard deviation stretch.
void	setRasterByRef(java.lang.Object ppRaster) The source raster object.
void	setStatisticsByRef(IArray ppStats) The custom raster stretch statistics.
void	setStretchType(int pStretchType) The stretch type.
void	setUseGamma(boolean pUseGamma) Indicates if applies Gamma stretch.

Field Detail

IID3e5a8ca3_6a10_4a3e_a49b_bbc4c86e23fe

static final int IID3e5a8ca3_6a10_4a3e_a49b_bbc4c86e23fe

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getRaster

java.lang.Object getRaster()
                    throws java.io.IOException,
                           AutomationException

The source raster object.

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(java.lang.Object ppRaster)
             throws java.io.IOException,
                    AutomationException

The source raster object.

Parameters:

ppRaster - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStretchType

int getStretchType()
            throws java.io.IOException,
                   AutomationException

The stretch type.

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterStretchType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStretchType

void setStretchType(int pStretchType)
             throws java.io.IOException,
                    AutomationException

The stretch type.

Parameters:

pStretchType - A com.esri.arcgis.datasourcesraster.esriRasterStretchType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGamma

IDoubleArray getGamma()
               throws java.io.IOException,
                      AutomationException

The list of Gamma value(s).

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGammaByRef

void setGammaByRef(IDoubleArray ppGamma)
            throws java.io.IOException,
                   AutomationException

The list of Gamma value(s).

Parameters:

ppGamma - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatistics

IArray getStatistics()
              throws java.io.IOException,
                     AutomationException

The custom raster stretch statistics.

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.

setStatisticsByRef

void setStatisticsByRef(IArray ppStats)
                 throws java.io.IOException,
                        AutomationException

The custom raster stretch statistics.

Parameters:

ppStats - 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.

getHistograms

IArray getHistograms()
              throws java.io.IOException,
                     AutomationException

The custom raster stretch histogram.

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.

setHistogramsByRef

void setHistogramsByRef(IArray ppHistograms)
                 throws java.io.IOException,
                        AutomationException

The custom raster stretch histogram.

Parameters:

ppHistograms - 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.

setNumberOfStandardDeviations

void setNumberOfStandardDeviations(double pNumStdDevs)
                            throws java.io.IOException,
                                   AutomationException

The number of standard deviations for standard deviation stretch.

Parameters:

pNumStdDevs - The pNumStdDevs (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberOfStandardDeviations

double getNumberOfStandardDeviations()
                              throws java.io.IOException,
                                     AutomationException

The number of standard deviations for standard deviation stretch.

Returns:

The pNumStdDevs

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseGamma

boolean isUseGamma()
            throws java.io.IOException,
                   AutomationException

Indicates if applies Gamma stretch.

Returns:

The pUseGamma

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseGamma

void setUseGamma(boolean pUseGamma)
          throws java.io.IOException,
                 AutomationException

Indicates if applies Gamma stretch.

Parameters:

pUseGamma - The pUseGamma (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMin

double getMin()
       throws java.io.IOException,
              AutomationException

The current minimum output value.

Returns:

The pMinValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMin

void setMin(double pMinValue)
     throws java.io.IOException,
            AutomationException

The current minimum output value.

Parameters:

pMinValue - The pMinValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMax

double getMax()
       throws java.io.IOException,
              AutomationException

The current maximum output value.

Returns:

The pMaxValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMax

void setMax(double pMaxValue)
     throws java.io.IOException,
            AutomationException

The current maximum output value.

Parameters:

pMaxValue - The pMaxValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinPercent

double getMinPercent()
              throws java.io.IOException,
                     AutomationException

The current minimum percent value.

Returns:

The pPercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinPercent

void setMinPercent(double pPercent)
            throws java.io.IOException,
                   AutomationException

The current minimum percent value.

Parameters:

pPercent - The pPercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxPercent

double getMaxPercent()
              throws java.io.IOException,
                     AutomationException

The current maximum percent value.

Returns:

The pPercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxPercent

void setMaxPercent(double pPercent)
            throws java.io.IOException,
                   AutomationException

The current maximum percent value.

Parameters:

pPercent - The pPercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.