com.esri.arcgis.datasourcesraster
Interface IRasterLoader

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterLoader

public interface IRasterLoader
extends Serializable

Provides access to members that control data loading.

Remarks

The IRasterLoader interface allows you to specify certain ways to load raster data into an existing raster dataset.

The Background property sets the background value of the input raster to be ignored when loading. If the input raster has multiple bands, the background value will be applied to all the bands.

The Foreground property sets the foreground pixel value for a one-bit raster data. When loading one bit raster data to ArcSDE, you can set this value to 255 so that the one bit raster will be loaded as eight bit. For a one-bit file based raster, its pyramids are calculated and stored using eight-bit data range, so the display of pyramid layers is more pleasant than one-bit pyramid layers. ArcSDE doesn’t allow pyramid layers have different bit depth from the base data, so by setting this property the ArcSDE will store both base data and pyramid layers as eight-bit data.

The MosaicColormapMode property sets the operation mode for colormap manipulation. The rstMosaicColormapMode enumeration includes four modes: MM_FIRST, MM_LAST, MM_MATCH, MM_REJECT.

MM_REJECT mode does not allow mosaic of rasters with colormap;
MM_FIRST mode uses the first colormap (the colormap of the existing dataset)
MM_LAST mode uses the last colormap (the colormap of the raster to be loaded)
MM_MATCH mode matches the colormap of the raster to be loaded to the existing dataset and remap the pixel values (colormap indexes) of the raster

The ArcSDE dataset colormap will be automatically updated (dropped and then loaded again).

The PixelAlignmentTolerance property sets the tolerance for resampling.

The Load method appends the input raster into the existing raster dataset.

The LoadRasters methods appends an array of rasters into the existing raster dataset.

Product Availability

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

See Also:

RasterLoader

Method Summary

Object	getBackground() The background value to filtered.
Object	getForeground() The foreground value for 1-Bit images.
int	getMosaicColormapMode() The colormap mode for loading psdeucolor raster datasets.
double	getPixelAlignmentTolerance() The pixel alignment tolerance.
void	load(IRasterDataset pDataset, IRaster raster) Loads (mosaics) a Raster into a RasterDataset.
void	loadRasters(IRasterDataset pDataset, IArray rasters) Loads (mosaics) an array of Rasters into a RasterDataset.
void	setBackground(Object background) The background value to filtered.
void	setForeground(Object foreground) The foreground value for 1-Bit images.
void	setMosaicColormapMode(int mode) The colormap mode for loading psdeucolor raster datasets.
void	setPixelAlignmentTolerance(double tolerance) The pixel alignment tolerance.

Method Detail

getPixelAlignmentTolerance

double getPixelAlignmentTolerance()
                                  throws IOException,
                                         AutomationException

The pixel alignment tolerance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The tolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelAlignmentTolerance

void setPixelAlignmentTolerance(double tolerance)
                                throws IOException,
                                       AutomationException

The pixel alignment tolerance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

tolerance - The tolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

Object getBackground()
                     throws IOException,
                            AutomationException

The background value to filtered.

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.

setBackground

void setBackground(Object background)
                   throws IOException,
                          AutomationException

The background value to filtered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

background - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getForeground

Object getForeground()
                     throws IOException,
                            AutomationException

The foreground value for 1-Bit images.

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.

setForeground

void setForeground(Object foreground)
                   throws IOException,
                          AutomationException

The foreground value for 1-Bit images.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

foreground - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicColormapMode

int getMosaicColormapMode()
                          throws IOException,
                                 AutomationException

The colormap mode for loading psdeucolor raster datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.datasourcesraster.rstMosaicColormapMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicColormapMode

void setMosaicColormapMode(int mode)
                           throws IOException,
                                  AutomationException

The colormap mode for loading psdeucolor raster datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mode - A com.esri.arcgis.datasourcesraster.rstMosaicColormapMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

void load(IRasterDataset pDataset,
          IRaster raster)
          throws IOException,
                 AutomationException

Loads (mosaics) a Raster into a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadRasters

void loadRasters(IRasterDataset pDataset,
                 IArray rasters)
                 throws IOException,
                        AutomationException

Loads (mosaics) an array of Rasters into a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

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