BuildRasterPyramidsParameters Class

Member Function Documentation

[explicit] BuildRasterPyramidsParameters::BuildRasterPyramidsParameters(QObject *parent = nullptr)

Creates a build pyramids parameters object.

• parent - The optional parent QObject.

[override virtual noexcept] BuildRasterPyramidsParameters::~BuildRasterPyramidsParameters()

Destructor.

Esri::ArcGISRuntime::RasterPyramidCompressionType BuildRasterPyramidsParameters::compressionType() const

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

See also setCompressionType().

bool BuildRasterPyramidsParameters::isSkipFirstLevel() const

Returns whether the first pyramid level is skipped.

When true, the first reduced-resolution level is omitted. This reduces disk usage but can reduce display performance at scales where that first overview level would otherwise be used.

The default value is false.

int BuildRasterPyramidsParameters::jpegCompressionQuality() const

Returns the JPEG compression quality to use when building pyramids.

This value is used only when compressionType is RasterPyramidCompressionType::Jpeg or RasterPyramidCompressionType::JpegYCbCr.

Valid values range from 1 to 100. Higher values preserve more visual detail but typically produce larger pyramid files (.ovr). No error or error is emitted if a value outside this range is provided. When pyramids are built, values above 100 are clamped to 100, and values below 1 use the default value.

The default value is 75.

See also setJpegCompressionQuality().

int BuildRasterPyramidsParameters::maximumLevelCount() const

Returns the maximum number of pyramid levels to create.

The default value is 0, which builds the full set of pyramid levels for the raster.

A value greater than 0 builds up to that number of pyramid levels, but no more than the full set of levels available for the raster.

Negative values are not supported. If this value is negative, RasterPyramids::buildPyramids(Esri::ArcGISRuntime::BuildRasterPyramidsParameters*) emits an error. Use RasterPyramids::deletePyramids to delete pyramids stored in a pyramid file (.ovr).

See also setMaximumLevelCount().

Esri::ArcGISRuntime::RasterResamplingType BuildRasterPyramidsParameters::resamplingType() const

Returns the resampling method used to generate pyramid levels.

All RasterResamplingType values are supported for pyramid generation. When this property is RasterResamplingType::Automatic, the runtime chooses an appropriate resampling method based on the raster.

The default value is RasterResamplingType::Automatic.

See also setResamplingType().

void BuildRasterPyramidsParameters::setCompressionType(Esri::ArcGISRuntime::RasterPyramidCompressionType compressionType)

Sets the compressionType to compressionType.

See also compressionType.

void BuildRasterPyramidsParameters::setJpegCompressionQuality(int jpegCompressionQuality)

Sets the jpegCompressionQuality to jpegCompressionQuality.

See also jpegCompressionQuality.

void BuildRasterPyramidsParameters::setMaximumLevelCount(int maximumLevelCount)

Sets the maximumLevelCount to maximumLevelCount.

See also maximumLevelCount.

void BuildRasterPyramidsParameters::setResamplingType(Esri::ArcGISRuntime::RasterResamplingType resamplingType)

Sets the resamplingType to resamplingType.

See also resamplingType.

void BuildRasterPyramidsParameters::setSkipFirstLevel(bool skipFirstLevel)

Sets the skipFirstLevel to skipFirstLevel.

See also isSkipFirstLevel.