com.esri.arcgis.datasourcesraster
Interface IMosaicFunction2

All Superinterfaces:

IMosaicFunction, Serializable

All Known Implementing Classes:

MosaicFunction

public interface IMosaicFunction2
extends IMosaicFunction, Serializable

Provides access to members that control mosaic function.

Product Availability

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

Method Summary

IRaster	getBackgroundRaster() The background raster.
int	getBlendingWidth() The blending width in pixels for Blend mosaic operator.
boolean	isClipToBoundary() Indicates if the mosaic dataset will be clipped to its boundary.
boolean	isFootprintMayContainNoData() Indicates whether the footprint geometry associated with each raster may contain NoData pixels.
void	setBackgroundRasterByRef(IRaster ppRaster) The background raster.
void	setBlendingWidth(int pWidth) The blending width in pixels for Blend mosaic operator.
void	setClipToBoundary(boolean pClipping) Indicates if the mosaic dataset will be clipped to its boundary.
void	setFootprintMayContainNoData(boolean pbFootprintMayContainNoData) Indicates whether the footprint geometry associated with each raster may contain NoData pixels.

Methods inherited from interface com.esri.arcgis.datasourcesraster.IMosaicFunction

constructQueryExpression, getCatalog, getCellsizeFieldName, getDefinitionExpression, getDefinitionFIDs, getDefinitionGeometry, getFIDs, getFootprintSymbol, getLockRasterFieldName, getLockRasterID, getLODFieldName, getLODInfos, getMaxCellsizeFieldIndex, getMaxCellsizeFieldName, getMaximumVisibleCellsize, getMaxMosaicImageCount, getMinCellsizeFieldIndex, getMinCellsizeFieldName, getMosaicMethod, getMosaicOperator, getMosaicOperatorType, getOrderByBaseValue, getOrderByFieldName, getRasterFieldIndex, getRasterFieldName, getViewpoint, getWhereClause, isApplyColorCorrection, isAscending, isClipToFootprint, isDrawFootprint, isVisible, lockCellsize, search, setApplyColorCorrection, setAscending, setCellsizeFieldName, setClipToFootprint, setDefinitionExpression, setDefinitionFIDsByRef, setDefinitionGeometryByRef, setDrawFootprint, setFIDsByRef, setFootprintSymbolByRef, setLockRasterFieldName, setLockRasterID, setLODFieldName, setLODInfosByRef, setMaxCellsizeFieldName, setMaximumVisibleCellsize, setMaxMosaicImageCount, setMinCellsizeFieldName, setMosaicMethod, setMosaicOperatorByRef, setMosaicOperatorType, setOrderByBaseValue, setOrderByFieldName, setRasterFieldName, setViewpointByRef, setWhereClause, unlockCellsize

Method Detail

isClipToBoundary

boolean isClipToBoundary()
                         throws IOException,
                                AutomationException

Indicates if the mosaic dataset will be clipped to its boundary.

Product Availability

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

Returns:

The pClipping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipToBoundary

void setClipToBoundary(boolean pClipping)
                       throws IOException,
                              AutomationException

Indicates if the mosaic dataset will be clipped to its boundary.

Product Availability

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

Parameters:

pClipping - The pClipping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundRaster

IRaster getBackgroundRaster()
                            throws IOException,
                                   AutomationException

The background raster.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundRasterByRef

void setBackgroundRasterByRef(IRaster ppRaster)
                              throws IOException,
                                     AutomationException

The background raster.

Product Availability

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

Parameters:

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

getBlendingWidth

int getBlendingWidth()
                     throws IOException,
                            AutomationException

The blending width in pixels for Blend mosaic operator.

Product Availability

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

Returns:

The pWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBlendingWidth

void setBlendingWidth(int pWidth)
                      throws IOException,
                             AutomationException

The blending width in pixels for Blend mosaic operator.

Product Availability

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

Parameters:

pWidth - The pWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFootprintMayContainNoData

boolean isFootprintMayContainNoData()
                                    throws IOException,
                                           AutomationException

Indicates whether the footprint geometry associated with each raster may contain NoData pixels. Setting this property to false while clipping to fooptrint enables the system to assume that only valid pixels exist within a raster's footprint towards optimizing ????&

Product Availability

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

Returns:

The pbFootprintMayContainNoData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFootprintMayContainNoData

void setFootprintMayContainNoData(boolean pbFootprintMayContainNoData)
                                  throws IOException,
                                         AutomationException

Indicates whether the footprint geometry associated with each raster may contain NoData pixels. Setting this property to false while clipping to fooptrint enables the system to assume that only valid pixels exist within a raster's footprint towards optimizing ????&

Product Availability

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

Parameters:

pbFootprintMayContainNoData - The pbFootprintMayContainNoData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.