com.esri.arcgis.carto
Interface IRasterDefaultsEnv

All Superinterfaces:
Serializable
All Known Subinterfaces:
IRasterDefaultsEnv2, IRasterDefaultsEnv3, IRasterDefaultsEnv4
All Known Implementing Classes:
RasterDefaultsEnv

public interface IRasterDefaultsEnv
extends Serializable

Provides access to members that control the default raster environment.

Superseded By

IRasterDefaultsEnv4

When To Use

The IRasterDefaultsEnv interface provides access to raster default properties that are shared between all supported raster formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IRasterFormatInfo getFormat(int i)
          Information about the format indicated by index i.
 int getNumFormats()
          Number of supported raster formats.
 int getPyramidCreateOpt()
          Default pyramid creation option.
 boolean isUseExtChecking()
          Indicates if extension checking is on.
 void query3BandRGB(int[] redIndex, int[] greenIndex, int[] blueIndex)
          Default zero indexed bands for a 3 band raster.
 void query4BandRGB(int[] redIndex, int[] greenIndex, int[] blueIndex)
          Default zero indexed bands for a 4 or more band raster.
 void set3BandRGB(int redIndex, int greenIndex, int blueIndex)
          Default zero indexed bands for a 3 band raster.
 void set4BandRGB(int redIndex, int greenIndex, int blueIndex)
          Default zero indexed bands for a 4 or more band raster.
 void setPyramidCreateOpt(int opt)
          Default pyramid creation option.
 void setUseExtChecking(boolean useExts)
          Indicates if extension checking is on.
 

Method Detail

getPyramidCreateOpt

int getPyramidCreateOpt()
                        throws IOException,
                               AutomationException
Default pyramid creation option.

Description

The PyramidCreateOpt property is used to set the pyramid options for displaying a large raster dataset, which has a dimension greater than 1024 and does not have pyramids, in ArcCatalog or ArcMap.
Pyramids is used to enhance display performance. For displaying raster datasets that do not have pyramids, ArcMap provides the following options: always build pyramids, never build pyramids, prompt a dialog box asking to build or not.
This method does not control pyramid building when you save as a raster dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPyramidCreateOpt

void setPyramidCreateOpt(int opt)
                         throws IOException,
                                AutomationException
Default pyramid creation option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

query3BandRGB

void query3BandRGB(int[] redIndex,
                   int[] greenIndex,
                   int[] blueIndex)
                   throws IOException,
                          AutomationException
Default zero indexed bands for a 3 band raster.

Remarks

The Query3BandRGB, Query4BandRGB, Set3BandRGB, and Set4BandRGB methods allow you to view or set the default band combinations used to display rasters with three or more bands. The indices set for these defaults will populate the red, green, and blue channels of the RGB renderer when a raster is initially displayed.

The Query3BandRGB and Set3BandRGB methods apply only to three band rasters, while the Query4BandRGB and Set4BandRGB methods apply to all rasters containing four or more bands.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
redIndex - The redIndex (out: use single element array)
greenIndex - The greenIndex (out: use single element array)
blueIndex - The blueIndex (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

set3BandRGB

void set3BandRGB(int redIndex,
                 int greenIndex,
                 int blueIndex)
                 throws IOException,
                        AutomationException
Default zero indexed bands for a 3 band raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

query4BandRGB

void query4BandRGB(int[] redIndex,
                   int[] greenIndex,
                   int[] blueIndex)
                   throws IOException,
                          AutomationException
Default zero indexed bands for a 4 or more band raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
redIndex - The redIndex (out: use single element array)
greenIndex - The greenIndex (out: use single element array)
blueIndex - The blueIndex (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

set4BandRGB

void set4BandRGB(int redIndex,
                 int greenIndex,
                 int blueIndex)
                 throws IOException,
                        AutomationException
Default zero indexed bands for a 4 or more band raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isUseExtChecking

boolean isUseExtChecking()
                         throws IOException,
                                AutomationException
Indicates if extension checking is on.

Description

This method is used to specify whether using file extension checking or not when you browse file based raster data such as .img, .tif, and jp2 etc.

Using file extension checking (true) is faster in browsing raster datasets, and this is the default.

Remarks

The UseExtChecking property specifies how ArcCatalog and the GxBrowser search for raster datasets. A True value for extension checking means that files or folders will be identified as raster datasets only if their extension matches the list of supported raster format extensions. A False value means that all files and folders will be opened to determine whether they are a raster dataset in any of the supported raster formats. This is more reliable but is much slower than extension checking only. Extension checking only is the default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUseExtChecking

void setUseExtChecking(boolean useExts)
                       throws IOException,
                              AutomationException
Indicates if extension checking is on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getNumFormats

int getNumFormats()
                  throws IOException,
                         AutomationException
Number of supported raster formats.

Remarks

The NumFormats property returns the number of supported raster formats, and the Format method returns a RasterFormatInfo object specific to one raster format, which can specify default properties for that format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFormat

IRasterFormatInfo getFormat(int i)
                            throws IOException,
                                   AutomationException
Information about the format indicated by index i.

Product Availability

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

Parameters:
i - The i (in)
Returns:
A reference to a com.esri.arcgis.carto.IRasterFormatInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.