com.esri.arcgis.datasourcesraster
Interface IStretchFunctionArguments

All Superinterfaces:

Serializable

All Known Implementing Classes:

IStretchFunctionArgumentsProxy, StretchFunctionArguments

public interface IStretchFunctionArguments
extends Serializable

Provides access to members that control stretch function arguments.

Product Availability

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

Method Summary

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

Method Detail

getRaster

Object getRaster()
                 throws IOException,
                        AutomationException

The source raster object.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException

The source raster object.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStretchType

int getStretchType()
                   throws IOException,
                          AutomationException

The stretch type.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterStretchType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStretchType

void setStretchType(int pStretchType)
                    throws IOException,
                           AutomationException

The stretch type.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGamma

IDoubleArray getGamma()
                      throws IOException,
                             AutomationException

The list of Gamma value(s).

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGammaByRef

void setGammaByRef(IDoubleArray ppGamma)
                   throws IOException,
                          AutomationException

The list of Gamma value(s).

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatistics

IArray getStatistics()
                     throws IOException,
                            AutomationException

The custom raster stretch statistics.

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.

setStatisticsByRef

void setStatisticsByRef(IArray ppStats)
                        throws IOException,
                               AutomationException

The custom raster stretch statistics.

Product Availability

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

Parameters:

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

getHistograms

IArray getHistograms()
                     throws IOException,
                            AutomationException

The custom raster stretch histogram.

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.

setHistogramsByRef

void setHistogramsByRef(IArray ppHistograms)
                        throws IOException,
                               AutomationException

The custom raster stretch histogram.

Product Availability

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

Parameters:

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

setNumberOfStandardDeviations

void setNumberOfStandardDeviations(double pNumStdDevs)
                                   throws IOException,
                                          AutomationException

The number of standard deviations for standard deviation stretch.

Product Availability

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

Parameters:

pNumStdDevs - The pNumStdDevs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberOfStandardDeviations

double getNumberOfStandardDeviations()
                                     throws IOException,
                                            AutomationException

The number of standard deviations for standard deviation stretch.

Product Availability

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

Returns:

The pNumStdDevs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseGamma

boolean isUseGamma()
                   throws IOException,
                          AutomationException

Indicates if applies Gamma stretch.

Product Availability

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

Returns:

The pUseGamma

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseGamma

void setUseGamma(boolean pUseGamma)
                 throws IOException,
                        AutomationException

Indicates if applies Gamma stretch.

Product Availability

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

Parameters:

pUseGamma - The pUseGamma (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMin

double getMin()
              throws IOException,
                     AutomationException

The current minimum output value.

Product Availability

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

Returns:

The pMinValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMin

void setMin(double pMinValue)
            throws IOException,
                   AutomationException

The current minimum output value.

Product Availability

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

Parameters:

pMinValue - The pMinValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMax

double getMax()
              throws IOException,
                     AutomationException

The current maximum output value.

Product Availability

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

Returns:

The pMaxValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMax

void setMax(double pMaxValue)
            throws IOException,
                   AutomationException

The current maximum output value.

Product Availability

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

Parameters:

pMaxValue - The pMaxValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinPercent

double getMinPercent()
                     throws IOException,
                            AutomationException

The current minimum percent value.

Product Availability

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

Returns:

The pPercent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinPercent

void setMinPercent(double pPercent)
                   throws IOException,
                          AutomationException

The current minimum percent value.

Product Availability

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

Parameters:

pPercent - The pPercent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxPercent

double getMaxPercent()
                     throws IOException,
                            AutomationException

The current maximum percent value.

Product Availability

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

Returns:

The pPercent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxPercent

void setMaxPercent(double pPercent)
                   throws IOException,
                          AutomationException

The current maximum percent value.

Product Availability

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

Parameters:

pPercent - The pPercent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.