Options controlling quantization for image compression with FITS. More...

#include <fitsCompression.h>

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

Public Attributes
DitherAlgorithm	dither = DitherAlgorithm::NO_DITHER_
	The method used to dither floating point values with random noise.

ScalingAlgorithm	scaling = ScalingAlgorithm::STDEV_MASKED
	The algorithm used to determine the scaling for quantization.

std::vector< std::string >	mask_planes = {"NO_DATA"}
	Mask planes to ignore when doing statistics.

float	level = 0
	Target quantization level.

int	seed = 0
	Random seed used for dithering.

Detailed Description

Options controlling quantization for image compression with FITS.

Definition at line 56 of file fitsCompression.h.

Member Function Documentation

◆ uses_mask()

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

inline

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

Definition at line 86 of file fitsCompression.h.

                           {
        switch (scaling) {
            case ScalingAlgorithm::RANGE:
            case ScalingAlgorithm::STDEV_MASKED:
                return true;
            case ScalingAlgorithm::STDEV_CFITSIO:
            case ScalingAlgorithm::MANUAL:
                break;
        };
        return false;
    }

Member Data Documentation

◆ dither

DitherAlgorithm lsst::afw::fits::QuantizationOptions::dither = DitherAlgorithm::NO_DITHER_

The method used to dither floating point values with random noise.

Definition at line 58 of file fitsCompression.h.

◆ level

float lsst::afw::fits::QuantizationOptions::level = 0

Target quantization level.

Interpretation depends on the scaling algorithm. For RANGE, this is ignored. For STDEV_*, this is the number of quantization levels within the standard deviation. For MANUAL, this is just ZSCALE, the factor the compressed integer values should be scaled by to (approximately) recover the original floating-point values.

Definition at line 75 of file fitsCompression.h.

◆ mask_planes

std::vector<std::string> lsst::afw::fits::QuantizationOptions::mask_planes = {"NO_DATA"}

Mask planes to ignore when doing statistics.

This is used by all STDEV_ algorithms except STDEV_CFITSIO.

Definition at line 66 of file fitsCompression.h.

66{"NO_DATA"};

◆ scaling

ScalingAlgorithm lsst::afw::fits::QuantizationOptions::scaling = ScalingAlgorithm::STDEV_MASKED

The algorithm used to determine the scaling for quantization.

Definition at line 61 of file fitsCompression.h.

◆ seed

int lsst::afw::fits::QuantizationOptions::seed = 0

Random seed used for dithering.

Must be between 1 and 10000 (inclusive) to be set explicitly; 0 signals that a random seed should be generated from the current time, and negative sets a random seed based on the checksum of the first tile.

Definition at line 82 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

Public Member Functions

Public Attributes