MaskedImageFitsReader.h

Go to the documentation of this file.

/*
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef LSST_AFW_IMAGE_MASKEDIMAGEFITSREADER_H
#define LSST_AFW_IMAGE_MASKEDIMAGEFITSREADER_H


#include "lsst/afw/image/ImageFitsReader.h"
#include "lsst/afw/image/MaskFitsReader.h"
#include "lsst/afw/image/MaskedImage.h"

namespace lsst { namespace afw { namespace image {

class MaskedImageFitsReader final {
public:

    explicit MaskedImageFitsReader(std::string const& fileName, int hdu=fits::DEFAULT_HDU);

    explicit MaskedImageFitsReader(fits::MemFileManager& manager, int hdu=fits::DEFAULT_HDU);

    explicit MaskedImageFitsReader(fits::Fits * fitsFile);

    // FITS readers are not copyable, movable, or assignable.
    MaskedImageFitsReader(MaskedImageFitsReader const &) = delete;
    MaskedImageFitsReader(MaskedImageFitsReader &&) = delete;
    MaskedImageFitsReader & operator=(MaskedImageFitsReader const &) = delete;
    MaskedImageFitsReader & operator=(MaskedImageFitsReader &&) = delete;

    ~MaskedImageFitsReader() noexcept;


    std::string readImageDType() const;
    std::string readMaskDType() const;
    std::string readVarianceDType() const;

    lsst::geom::Box2I readBBox(ImageOrigin origin=PARENT);

    lsst::geom::Point2I readXY0(
        lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
        ImageOrigin origin=PARENT
    );


    std::shared_ptr<daf::base::PropertyList> readPrimaryMetadata();
    std::shared_ptr<daf::base::PropertyList> readImageMetadata();
    std::shared_ptr<daf::base::PropertyList> readMaskMetadata();
    std::shared_ptr<daf::base::PropertyList> readVarianceMetadata();


    template <typename ImagePixelT>
    Image<ImagePixelT> readImage(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
                                 ImageOrigin origin=PARENT, bool allowUnsafe=false);
    template <typename ImagePixelT>
    ndarray::Array<ImagePixelT, 2, 2> readImageArray(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
                                                     ImageOrigin origin=PARENT, bool allowUnsafe=false);

    template <typename MaskPixelT>
    Mask<MaskPixelT> readMask(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
                              ImageOrigin origin=PARENT, bool conformMasks=false,
                              bool allowUnsafe=false);

    template <typename MaskPixelT>
    ndarray::Array<MaskPixelT, 2, 2> readMaskArray(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
                                                   ImageOrigin origin=PARENT, bool allowUnsafe=false);


    template <typename VariancePixelT>
    Image<VariancePixelT> readVariance(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
                                       ImageOrigin origin=PARENT, bool allowUnsafe=false);
    template <typename VariancePixelT>
    ndarray::Array<VariancePixelT, 2, 2> readVarianceArray(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
                                                           ImageOrigin origin=PARENT, bool allowUnsafe=false);

    template <typename ImagePixelT, typename MaskPixelT=MaskPixel, typename VariancePixelT=VariancePixel>
    MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT> read(
        lsst::geom::Box2I const & bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT,
        bool conformMasks=false, bool needAllHdus=false, bool allowUnsafe=false
    );

    std::string getFileName() const { return _imageReader.getFileName(); }

private:

    friend class ExposureFitsReader;

    fits::Fits * _getFitsFile() { return _imageReader._fitsFile; }

    std::shared_ptr<daf::base::PropertyList> _imageMetadata;
    std::shared_ptr<daf::base::PropertyList> _maskMetadata;
    std::shared_ptr<daf::base::PropertyList> _varianceMetadata;
    ImageFitsReader _imageReader;
    MaskFitsReader _maskReader;
    ImageFitsReader _varianceReader;
};

}}} // namespace lsst::afw::image

#endif // !LSST_AFW_IMAGE_MASKEDIMAGEFITSREADER_H