com.esri.arcgis.carto
Interface IGeoImageDescription2

All Superinterfaces:

IGeoImageDescription, Serializable

All Known Subinterfaces:

IGeoImageDescription3

All Known Implementing Classes:

GeoImageDescription

public interface IGeoImageDescription2
extends IGeoImageDescription, Serializable

Provides access to members that control an image description.

Remarks

IGeoImageDescription2 defines two additional properties: a mosaic rule on how mosaic should be performed, and a rendering rule on how the image should be rendered.

Product Availability

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

Method Summary

IMosaicRule	getMosaicRule() The mosaic rule.
IRenderingRule	getRenderingRule() The rendering rule.
boolean	isBSQ() Indicates if output should be generated in BSQ pxiel interleave format.
void	setBSQ(boolean pBSQ) Indicates if output should be generated in BSQ pxiel interleave format.
void	setMosaicRuleByRef(IMosaicRule ppMosaicRule) The mosaic rule.
void	setRenderingRuleByRef(IRenderingRule ppRenderingRule) The rendering rule.

Methods inherited from interface com.esri.arcgis.carto.IGeoImageDescription

getBandSelection, getCompression, getCompressionQuality, getExtent, getHeight, getInterpolation, getMosaicProperties, getNoData, getPixelType, getSpatialReference, getViewpointProperties, getWidth, setBandSelectionByRef, setCompression, setCompressionQuality, setExtentByRef, setHeight, setInterpolation, setMosaicProperties, setNoData, setPixelType, setSpatialReferenceByRef, setViewpointProperties, setWidth

Method Detail

getMosaicRule

IMosaicRule getMosaicRule()
                          throws IOException,
                                 AutomationException

The mosaic rule.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IMosaicRule

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicRuleByRef

void setMosaicRuleByRef(IMosaicRule ppMosaicRule)
                        throws IOException,
                               AutomationException

The mosaic rule.

Remarks

Specifies the mosaic rules when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, and etc.

Product Availability

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

Parameters:

ppMosaicRule - A reference to a com.esri.arcgis.carto.IMosaicRule (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderingRule

IRenderingRule getRenderingRule()
                                throws IOException,
                                       AutomationException

The rendering rule.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IRenderingRule

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderingRuleByRef

void setRenderingRuleByRef(IRenderingRule ppRenderingRule)
                           throws IOException,
                                  AutomationException

The rendering rule.

Remarks

MosaicRule value object is used to define the mosaic rule for mosaicking requested images on the fly. A mosaic rule contains a mosaic method, its parameters, and a mosaic operation. In general, a mosaic rule is used to specify (1) the selection of rasters to participate in the mosaic; (2) how the selected rasters are ordered; (3) how overlapping pixels at the same location are resolved.

Product Availability

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

Parameters:

ppRenderingRule - A reference to a com.esri.arcgis.carto.IRenderingRule (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBSQ

boolean isBSQ()
              throws IOException,
                     AutomationException

Indicates if output should be generated in BSQ pxiel interleave format.

Product Availability

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

Returns:

The pBSQ

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBSQ

void setBSQ(boolean pBSQ)
            throws IOException,
                   AutomationException

Indicates if output should be generated in BSQ pxiel interleave format.

Product Availability

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

Parameters:

pBSQ - The pBSQ (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.