arcgis-maps-kotlin/com.arcgismaps.raster/RasterPyramidInfo

RasterPyramidInfo

Information about a raster pyramid set. A raster pyramid set is a collection of reduced-resolution copies of a raster. These reduced-resolution levels let the runtime display the raster more efficiently at smaller scales by using data that is already closer to the requested resolution.

Pyramids for a raster can be embedded within the raster file or in a separate pyramid file (.ovr). When returned from RasterPyramids.pyramidInfo, it describes the pyramid set available for the raster.

Pyramids stored in a separate pyramid file (.ovr) can be deleted using RasterPyramids.deletePyramids. After the pyramids are deleted, new pyramids can be built using RasterPyramids.buildPyramids.

Since

300.1.0

Properties

compressionType

val compressionType: RasterPyramidCompressionType

The compression type used by the pyramid set. This property is RasterPyramidCompressionType.Default when the compression type cannot be determined from the available metadata. Otherwise, it represents the actual compression used by the pyramid set.

filePath

val filePath: String?

The path to the file that stores the pyramid set, if available. When the pyramid set is stored in a file, this property identifies that file. The path may refer to an .ovr file or to another file used by the raster format to store pyramid data.

isEmbedded

val isEmbedded: Boolean

True if pyramids are part of the source raster dataset, false otherwise. Pyramids can be part of the source raster dataset or stored in a separate pyramid file (.ovr). Dataset pyramids may be stored internally by the raster format or in format-managed sidecar files such as .rrd or .aux. In both cases, this property is true.

levelCount

val levelCount: Int

The number of levels in the pyramid set. Each level is a reduced-resolution representation of the source raster. This count does not include the full-resolution source raster.

resamplingType

val resamplingType: RasterResamplingType

The resampling method used to create the pyramid set. This property is RasterResamplingType.Automatic when the resampling method cannot be determined from the available metadata or is not represented by an exposed RasterResamplingType value.