Raster
Provides access to pyramid information and pyramid management operations for a raster. This object is owned by a Raster and exposes the current pyramid state for that raster. Use Raster.pyramids to get the instance associated with a raster. If the raster does not support pyramids, Raster.pyramids is null.
Pyramids for a raster can be embedded within the raster file or stored in a separate pyramid file (.ovr). This object can build and delete pyramids stored in a separate pyramid file when the raster source supports those operations.
To determine whether pyramids can be built, check that both RasterPyramids.pyramidInfo and RasterPyramids.activeBuildOperation are null. To determine whether pyramids can be deleted, check that RasterPyramids.pyramidInfo is not null, RasterPyramidInfo.isEmbedded is false, and RasterPyramids.activeBuildOperation is null. These checks describe the current pyramid state and whether a build is in progress; they do not guarantee that a build or delete request will succeed.
Since
300.1.0
Properties
The pyramid build operation currently running for the owning raster. This property is null when no pyramid build operation is in progress for the raster. When a build is in progress, this property returns the current operation so that callers can observe progress, request cancellation, or await the result.
Information about the raster's pyramid set. This property is null if no pyramids exist for the raster.
Functions
Starts building pyramids stored in a pyramid file (.ovr) for the owning raster. This method starts an operation that builds pyramids in a separate pyramid file (.ovr) for the owning raster and returns a handle to that operation.
Deletes pyramids stored in a pyramid file (.ovr) for the owning raster. This method deletes pyramids associated with the owning raster's external pyramid file (.ovr). It does not delete pyramids embedded in the source raster file.