lsst::afw::fits::CompressionOptions Struct Reference

Options controlling image compression with FITS. More...

#include <fitsCompression.h>

Public Member Functions
bool	uses_mask () const
	Whether this compression configuration would make use of a Mask and the configured mask_planes.

Public Attributes
CompressionAlgorithm	algorithm = CompressionAlgorithm::GZIP_2_
	The compression algorithm to use.
std::size_t	tile_width = 0
	Shape of a compression tile.
std::size_t	tile_height = 1
std::optional< QuantizationOptions >	quantization = std::nullopt
	Options for quantizing a floating point image (i.e. lossy compression).

Detailed Description

Options controlling image compression with FITS.

Definition at line 100 of file fitsCompression.h.

Member Function Documentation

uses_mask()

bool lsst::afw::fits::CompressionOptions::uses_mask ( ) const

inline

Whether this compression configuration would make use of a Mask and the configured mask_planes.

Definition at line 118 of file fitsCompression.h.

                           {
        return quantization.has_value() && quantization.value().uses_mask();
    }

Member Data Documentation

algorithm

CompressionAlgorithm lsst::afw::fits::CompressionOptions::algorithm = CompressionAlgorithm::GZIP_2_

The compression algorithm to use.

Definition at line 103 of file fitsCompression.h.

quantization

std::optional<QuantizationOptions> lsst::afw::fits::CompressionOptions::quantization = std::nullopt

Options for quantizing a floating point image (i.e. lossy compression).

Definition at line 114 of file fitsCompression.h.

tile_height

std::size_t lsst::afw::fits::CompressionOptions::tile_height = 1

Definition at line 110 of file fitsCompression.h.

tile_width

std::size_t lsst::afw::fits::CompressionOptions::tile_width = 0

Shape of a compression tile.

Zeros are replaced by the length of the image in that dimension.

Definition at line 109 of file fitsCompression.h.

---

The documentation for this struct was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g9722cb1a7f+d8f85438e7/include/lsst/afw/fitsCompression.h