compressionType property

The compression type to use when building pyramids.

The default value is RasterPyramidCompressionType.default_. This allows the runtime to choose the compression used for the generated pyramids based on the raster.

A requested compression type must be supported by the raster format, pixel type, and underlying raster implementation. File-based rasters that support pyramids stored in a pyramid file (.ovr) can generally request RasterPyramidCompressionType.deflate, RasterPyramidCompressionType.jpeg, RasterPyramidCompressionType.jpegYCbCr, RasterPyramidCompressionType.lzw, or RasterPyramidCompressionType.none. JPEG-based options are generally appropriate only for compatible imagery where smaller file size is more important than preserving exact pixel values.

If the requested compression cannot be applied for the generated pyramids, the runtime may fall back to its default pyramid compression. Some unsupported format, pixel type, or implementation combinations can still cause pyramid building to fail. After the pyramid build operation completes successfully, use RasterPyramids.pyramidInfo to inspect the actual compression used for the generated pyramids.