com.esri.arcgis.carto
Interface IRasterStretch

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterRGBRenderer, RasterStretchColorRampRenderer

public interface IRasterStretch
extends Serializable

Provides access to members which control contrast stretching.

Superseded By

IRasterStretch2

When To Use

The IRasterStretch interface is used to set stretch type for RasterStretchColorRampRenderer or RasterRGBRenderer. It controls how the values in a band are binned for display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Use the newer IRasterStretch2 interface instead of IRasterStretch.


Method Summary
 IColor getBackgroundColor()
          Background display color.
 double getBackgroundValues()
          Indicates whether an array of background values is being used.
 double getStandardDeviationsParam()
          Standard deviation parameter for the stretch renderer.
 int getStretchType()
          Current stretch type.
 boolean isBackground()
          Indicates if a background value is being used.
 boolean isInvert()
          Indicates if the stretch is inverted.
 void setBackground(boolean b)
          Indicates if a background value is being used.
 void setBackgroundColorByRef(IColor ppColor)
          Background display color.
 void setBackgroundValues(double[] pBkg)
          Indicates whether an array of background values is being used.
 void setInvert(boolean pInvert)
          Indicates if the stretch is inverted.
 void setStandardDeviationsParam(double param)
          Standard deviation parameter for the stretch renderer.
 void setStretchType(int en_stretch)
          Current stretch type.
 

Method Detail

setStretchType

void setStretchType(int en_stretch)
                    throws IOException,
                           AutomationException
Current stretch type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
en_stretch - A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchType

int getStretchType()
                   throws IOException,
                          AutomationException
Current stretch type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStandardDeviationsParam

void setStandardDeviationsParam(double param)
                                throws IOException,
                                       AutomationException
Standard deviation parameter for the stretch renderer.

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.

getStandardDeviationsParam

double getStandardDeviationsParam()
                                  throws IOException,
                                         AutomationException
Standard deviation parameter for the stretch renderer.

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.

setInvert

void setInvert(boolean pInvert)
               throws IOException,
                      AutomationException
Indicates if the stretch is inverted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pInvert - The pInvert (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInvert

boolean isInvert()
                 throws IOException,
                        AutomationException
Indicates if the stretch is inverted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pInvert
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackground

void setBackground(boolean b)
                   throws IOException,
                          AutomationException
Indicates if a background value is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
b - The b (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBackground

boolean isBackground()
                     throws IOException,
                            AutomationException
Indicates if a background value is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The b
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundValues

double getBackgroundValues()
                           throws IOException,
                                  AutomationException
Indicates whether an array of background values is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pBkg
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundValues

void setBackgroundValues(double[] pBkg)
                         throws IOException,
                                AutomationException
Indicates whether an array of background values is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

To set a list of background values, use IRasterStretch2::setBackgroundValue() instead.

Parameters:
pBkg - The pBkg (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
Background display color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundColorByRef

void setBackgroundColorByRef(IColor ppColor)
                             throws IOException,
                                    AutomationException
Background display color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.