com.esri.arcgis.carto
Interface IRasterStretchMinMax

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterStretchColorRampRenderer

public interface IRasterStretchMinMax
extends Serializable

Provides access to min/max members which control contrast stretching.

Remarks

The IRasterStretchMinMax interface allows specification of custom minimum and maximum values when rendering a raster band using a linear stretch. This interface is useful when multiple images need to be displayed with same stretch.

Product Availability

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

Method Summary

double	getCustomStretchMax() The custom maximum value for stretch renderer type "Minimum-Maximum".
double	getCustomStretchMin() The custom minimum value for stretch renderer type "Minimum-Maximum".
double	getStretchMax() The maximum value used for stretching cell values.
double	getStretchMin() The minimum value used for stretching cell values.
boolean	isUseCustomStretchMinMax() Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".
void	setCustomStretchMax(double param) The custom maximum value for stretch renderer type "Minimum-Maximum".
void	setCustomStretchMin(double param) The custom minimum value for stretch renderer type "Minimum-Maximum".
void	setUseCustomStretchMinMax(boolean pUse) Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".

Method Detail

getStretchMin

double getStretchMin()
                     throws IOException,
                            AutomationException

The minimum value used for stretching cell values.

Remarks

The StretchMax and StretchMin properties return the existing minimum and maximum values from the raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The param

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStretchMax

double getStretchMax()
                     throws IOException,
                            AutomationException

The maximum value used for stretching cell values.

Remarks

The StretchMax and StretchMin properties return the existing minimum and maximum values from the raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The param

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomStretchMin

void setCustomStretchMin(double param)
                         throws IOException,
                                AutomationException

The custom minimum value for stretch renderer type "Minimum-Maximum".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

param - The param (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomStretchMin

double getCustomStretchMin()
                           throws IOException,
                                  AutomationException

The custom minimum value for stretch renderer type "Minimum-Maximum".

Remarks

The CustomStretchMax and CustomStretchMin properties specify custom minimum and maximum values to be used.

The property IRasterStretchType::StretchType must be set to be esriRasterStretch_MinimumMaximum before using the custom minimum and maximum values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The param

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomStretchMax

void setCustomStretchMax(double param)
                         throws IOException,
                                AutomationException

The custom maximum value for stretch renderer type "Minimum-Maximum".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

param - The param (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomStretchMax

double getCustomStretchMax()
                           throws IOException,
                                  AutomationException

The custom maximum value for stretch renderer type "Minimum-Maximum".

Remarks

The CustomStretchMax and CustomStretchMin properties specify custom minimum and maximum values to be used.

The property IRasterStretchType::StretchType must be set to be esriRasterStretch_MinimumMaximum before using the custom minimum and maximum values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The param

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCustomStretchMinMax

void setUseCustomStretchMinMax(boolean pUse)
                               throws IOException,
                                      AutomationException

Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pUse - The pUse (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCustomStretchMinMax

boolean isUseCustomStretchMinMax()
                                 throws IOException,
                                        AutomationException

Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".

Remarks

The UseCustomStretchMinMax property must be true in order to use the minimum and maximum values you have specified; setting this property to be false the minimum and maximum values in the raster band or raster dataset will be used in rendering.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pUse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.