com.esri.arcgis.carto
Interface IRasterStretch2

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

public interface IRasterStretch2
extends Serializable

Provides access to members which control stretch.

Description

The IRasterStretch2 interface sets pixel information such as statistics and histograms to the raster renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IColor getBackgroundColor()
          The color of background.
 Object getBackgroundValue()
          The list of background value(s).
 IArray getSpecificationHistogram()
          The statistics for histogram specification stretch.
 double getStandardDeviationsParam()
          The standard deviation parameter for the stretch renderer.
 IArray getStretchStats()
          The global raster stretch statistics.
 int getStretchStatsType()
          The current stretch statistics type.
 int getStretchType()
          The 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)
          The color of background.
 void setBackgroundValue(Object background)
          The list of background value(s).
 void setInvert(boolean pInvert)
          Indicates if the stretch is inverted.
 void setSpecificationHistogramByRef(IArray pRGBStats)
          The statistics for histogram specification stretch.
 void setStandardDeviationsParam(double param)
          The standard deviation parameter for the stretch renderer.
 void setStretchStatsByRef(IArray ppRGBStats)
          The global raster stretch statistics.
 void setStretchStatsType(int stats)
          The current stretch statistics type.
 void setStretchType(int stretch)
          The current stretch type.
 

Method Detail

setStretchType

void setStretchType(int stretch)
                    throws IOException,
                           AutomationException
The current stretch type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
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
The 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
The 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
The 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.

getBackgroundValue

Object getBackgroundValue()
                          throws IOException,
                                 AutomationException
The list of background value(s).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBackgroundValue

void setBackgroundValue(Object background)
                        throws IOException,
                               AutomationException
The list of background value(s).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

For example :-

IRasterStretch2 rasterStretch2 = ...;
double[] values = new double[1];
values[0] = 1;
rasterStretch.setBackgroundValue(values);

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

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
The color of background.

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
The color of background.

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.

setStretchStatsType

void setStretchStatsType(int stats)
                         throws IOException,
                                AutomationException
The current stretch statistics type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getStretchStatsType

int getStretchStatsType()
                        throws IOException,
                               AutomationException
The current stretch statistics type.

Remarks

The StretchStatsType property specifies the stretch statistics type. The option esriRasterStretchStats_AreaOfView uses statistics dynamically calculated from the current display area, whereby the option esriRasterStretchStats_Dataset uses statistics from the raster dataset, and the option esriRasterStretchStats_GlobalStats uses user-defined statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStretchStatsByRef

void setStretchStatsByRef(IArray ppRGBStats)
                          throws IOException,
                                 AutomationException
The global raster stretch statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppRGBStats - 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.

getStretchStats

IArray getStretchStats()
                       throws IOException,
                              AutomationException
The global raster stretch statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setSpecificationHistogramByRef

void setSpecificationHistogramByRef(IArray pRGBStats)
                                    throws IOException,
                                           AutomationException
The statistics for histogram specification stretch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pRGBStats - 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.

getSpecificationHistogram

IArray getSpecificationHistogram()
                                 throws IOException,
                                        AutomationException
The statistics for histogram specification stretch.

Remarks

The SpecificationHistogram property specifies histograms. You must set the stretch type (IRasterStretch::StretchType) to be esri_HistogramSpecification in order for the specified histograms to be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.