ExposureFitsReader.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_EXPOSUREFITSREADER_H
#define LSST_AFW_IMAGE_EXPOSUREFITSREADER_H
 
#include <optional>
 
#include "lsst/afw/image/MaskedImageFitsReader.h"
#include "lsst/afw/image/ExposureInfo.h"
#include "lsst/afw/image/Exposure.h"
 
namespace lsst {
namespace afw {
namespace image {
 
class ExposureFitsReader {
public:
    explicit ExposureFitsReader(std::string const &fileName);
 
    explicit ExposureFitsReader(fits::MemFileManager &manager);
 
    explicit ExposureFitsReader(fits::Fits *fitsFile);
 
    // FITS readers are not copyable, movable, or assignable.
    ExposureFitsReader(ExposureFitsReader const &) = delete;
    ExposureFitsReader(ExposureFitsReader &&) = delete;
    ExposureFitsReader &operator=(ExposureFitsReader const &) = delete;
    ExposureFitsReader &operator=(ExposureFitsReader &&) = delete;
 
    ~ExposureFitsReader() 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);
 
    int readSerializationVersion();
 
    std::shared_ptr<daf::base::PropertyList> readMetadata();
 
    std::optional<table::RecordId> readExposureId();
 
    std::shared_ptr<afw::geom::SkyWcs> readWcs();
 
    // TODO: remove in DM-27811
    [[deprecated("Replaced by readFilter. Will be removed after v24.")]]
    std::shared_ptr<FilterLabel> readFilterLabel();
 
    std::shared_ptr<FilterLabel> readFilter();
 
    std::shared_ptr<PhotoCalib> readPhotoCalib();
 
    std::shared_ptr<detection::Psf> readPsf();
 
    std::shared_ptr<afw::geom::polygon::Polygon> readValidPolygon();
 
    std::shared_ptr<ApCorrMap> readApCorrMap();
 
    std::shared_ptr<CoaddInputs> readCoaddInputs();
 
    std::shared_ptr<VisitInfo> readVisitInfo();
 
    std::shared_ptr<TransmissionCurve> readTransmissionCurve();
 
    std::shared_ptr<cameraGeom::Detector> readDetector();
 
    std::shared_ptr<typehandling::Storable> readComponent(std::string const &componentName);
 
    std::map<std::string, std::shared_ptr<table::io::Persistable>> readExtraComponents();
 
    std::shared_ptr<ExposureInfo> readExposureInfo();
 
 
    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> readMaskedImage(
            lsst::geom::Box2I const &bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT,
            bool conformMasks = false, bool allowUnsafe = false);
 
    template <typename ImagePixelT, typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
    Exposure<ImagePixelT, MaskPixelT, VariancePixelT> read(
            lsst::geom::Box2I const &bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT,
            bool conformMasks = false, bool allowUnsafe = false);
 
    std::string getFileName() const { return _maskedImageReader.getFileName(); }
 
private:
    class MetadataReader;
    class ArchiveReader;
 
    void _ensureReaders();
 
    fits::Fits *_getFitsFile() { return _maskedImageReader._getFitsFile(); }
 
    MaskedImageFitsReader _maskedImageReader;
    std::unique_ptr<MetadataReader> _metadataReader;
    std::unique_ptr<ArchiveReader> _archiveReader;
};
 
}  // namespace image
}  // namespace afw
}  // namespace lsst
 
#endif  // !LSST_AFW_IMAGE_EXPOSUREFITSREADER_H