fitsCompression.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
#ifndef LSST_AFW_fitsCompression_h_INCLUDED
#define LSST_AFW_fitsCompression_h_INCLUDED
 
#include <optional>
#include <string>
#include <type_traits>
#include <vector>
 
#include "ndarray.h"
#include "lsst/afw/image/Image.h"
#include "lsst/afw/image/Mask.h"
 
 
namespace lsst {
namespace afw {
namespace fits {
 
class Fits;

enum class CompressionAlgorithm {
    GZIP_1_,
    GZIP_2_,
    RICE_1_
};

enum class DitherAlgorithm {
    NO_DITHER_,
    SUBTRACTIVE_DITHER_1_,
    SUBTRACTIVE_DITHER_2_,
};

enum class ScalingAlgorithm {
    RANGE,           
    STDEV_MASKED,    
    STDEV_CFITSIO,   
    MANUAL,          
};

struct QuantizationOptions {
    DitherAlgorithm dither = DitherAlgorithm::NO_DITHER_;

    ScalingAlgorithm scaling = ScalingAlgorithm::STDEV_MASKED;

    std::vector<std::string> mask_planes = {"NO_DATA"};

    float level = 0;

    int seed = 0;

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

struct CompressionOptions {

    CompressionAlgorithm algorithm = CompressionAlgorithm::GZIP_2_;


    std::size_t tile_width = 0;
    std::size_t tile_height = 1;

    std::optional<QuantizationOptions> quantization = std::nullopt;

    bool uses_mask() const {
        return quantization.has_value() && quantization.value().uses_mask();
    }
};
 
}  // namespace fits
}  // namespace afw
}  // namespace lsst
 
#endif  // ifndef LSST_AFW_fitsCompression_h_INCLUDED