ExposureInfo.h

Go to the documentation of this file.

// -*- LSST-C++ -*- // fixed format comment for emacs
/*
 * This file is part of afw.
 *
 * 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_ExposureInfo_h_INCLUDED
#define LSST_AFW_IMAGE_ExposureInfo_h_INCLUDED

#include "lsst/base.h"
#include "lsst/daf/base.h"
#include "lsst/geom/Point.h"
#include "lsst/afw/image/Filter.h"
#include "lsst/afw/table/io/OutputArchive.h"
#include "lsst/afw/image/CoaddInputs.h"
#include "lsst/afw/image/VisitInfo.h"
#include "lsst/afw/image/detail/StorableMap.h"

namespace lsst {
namespace afw {

namespace cameraGeom {
class Detector;
}

namespace detection {
class Psf;
}

namespace geom {
namespace polygon {
class Polygon;
class SkyWcs;
}  // namespace polygon
}  // namespace geom

namespace fits {
class Fits;
}

namespace image {

class PhotoCalib;
class ApCorrMap;
class VisitInfo;
class TransmissionCurve;

class ExposureInfo final {
public:
    static typehandling::Key<std::string, std::shared_ptr<geom::SkyWcs const>> const KEY_WCS;
    static typehandling::Key<std::string, std::shared_ptr<detection::Psf const>> const KEY_PSF;
    static typehandling::Key<std::string, std::shared_ptr<PhotoCalib const>> const KEY_PHOTO_CALIB;
    static typehandling::Key<std::string, std::shared_ptr<cameraGeom::Detector const>> const KEY_DETECTOR;
    static typehandling::Key<std::string, std::shared_ptr<geom::polygon::Polygon const>> const
            KEY_VALID_POLYGON;
    static typehandling::Key<std::string, std::shared_ptr<CoaddInputs const>> const KEY_COADD_INPUTS;
    static typehandling::Key<std::string, std::shared_ptr<ApCorrMap const>> const KEY_AP_CORR_MAP;
    static typehandling::Key<std::string, std::shared_ptr<TransmissionCurve const>> const
            KEY_TRANSMISSION_CURVE;

    bool hasWcs() const;

    std::shared_ptr<geom::SkyWcs const> getWcs() const;

    void setWcs(std::shared_ptr<geom::SkyWcs const> wcs);

    bool hasDetector() const;

    std::shared_ptr<cameraGeom::Detector const> getDetector() const;

    void setDetector(std::shared_ptr<cameraGeom::Detector const> detector);

    Filter getFilter() const { return _filter; }

    void setFilter(Filter const& filter) { _filter = filter; }

    bool hasPhotoCalib() const;

    std::shared_ptr<PhotoCalib const> getPhotoCalib() const;

    void setPhotoCalib(std::shared_ptr<PhotoCalib const> photoCalib);

    std::shared_ptr<daf::base::PropertySet> getMetadata() const { return _metadata; }

    void setMetadata(std::shared_ptr<daf::base::PropertySet> metadata) { _metadata = metadata; }

    bool hasPsf() const;

    std::shared_ptr<detection::Psf const> getPsf() const;

    void setPsf(std::shared_ptr<detection::Psf const> psf);

    bool hasValidPolygon() const;

    std::shared_ptr<geom::polygon::Polygon const> getValidPolygon() const;

    void setValidPolygon(std::shared_ptr<geom::polygon::Polygon const> polygon);

    bool hasApCorrMap() const;

    std::shared_ptr<ApCorrMap const> getApCorrMap() const;

    void setApCorrMap(std::shared_ptr<ApCorrMap const> apCorrMap);

    void initApCorrMap();

    bool hasCoaddInputs() const;

    void setCoaddInputs(std::shared_ptr<CoaddInputs const> coaddInputs);

    std::shared_ptr<CoaddInputs const> getCoaddInputs() const;

    std::shared_ptr<image::VisitInfo const> getVisitInfo() const { return _visitInfo; }

    bool hasVisitInfo() const { return static_cast<bool>(_visitInfo); }

    void setVisitInfo(std::shared_ptr<image::VisitInfo const> const visitInfo) { _visitInfo = visitInfo; }

    bool hasTransmissionCurve() const;

    std::shared_ptr<TransmissionCurve const> getTransmissionCurve() const;

    void setTransmissionCurve(std::shared_ptr<TransmissionCurve const> tc);

    template <class T>
    void setComponent(typehandling::Key<std::string, std::shared_ptr<T>> const& key,
                      std::shared_ptr<T> const& object) {
        static_assert(std::is_base_of<typehandling::Storable, T>::value, "T must be a Storable");
        // "No data" always represented internally by absent key-value pair, not by mapping to null
        if (object != nullptr) {
            _setComponent(key, object);
        } else {
            removeComponent(key);
        }
    }

    template <class T>
    bool hasComponent(typehandling::Key<std::string, T> const& key) const {
        return _components->contains(key);
    }

    template <class T>
    std::shared_ptr<T> getComponent(typehandling::Key<std::string, std::shared_ptr<T>> const& key) const {
        try {
            return _components->at(key);
        } catch (pex::exceptions::OutOfRangeError const& e) {
            return nullptr;
        }
    }

    template <class T>
    bool removeComponent(typehandling::Key<std::string, T> const& key) {
        return _components->erase(key);
    }

    static int getFitsSerializationVersion();

    static std::string const& getFitsSerializationVersionName();

    explicit ExposureInfo(
            std::shared_ptr<geom::SkyWcs const> const& wcs = std::shared_ptr<geom::SkyWcs const>(),
            std::shared_ptr<detection::Psf const> const& psf = std::shared_ptr<detection::Psf const>(),
            std::shared_ptr<PhotoCalib const> const& photoCalib = std::shared_ptr<PhotoCalib const>(),
            std::shared_ptr<cameraGeom::Detector const> const& detector =
                    std::shared_ptr<cameraGeom::Detector const>(),
            std::shared_ptr<geom::polygon::Polygon const> const& polygon =
                    std::shared_ptr<geom::polygon::Polygon const>(),
            Filter const& filter = Filter(),
            std::shared_ptr<daf::base::PropertySet> const& metadata =
                    std::shared_ptr<daf::base::PropertySet>(),
            std::shared_ptr<CoaddInputs> const& coaddInputs = std::shared_ptr<CoaddInputs>(),
            std::shared_ptr<ApCorrMap> const& apCorrMap = std::shared_ptr<ApCorrMap>(),
            std::shared_ptr<image::VisitInfo const> const& visitInfo =
                    std::shared_ptr<image::VisitInfo const>(),
            std::shared_ptr<TransmissionCurve const> const& transmissionCurve =
                    std::shared_ptr<TransmissionCurve>());

    ExposureInfo(ExposureInfo const& other);
    ExposureInfo(ExposureInfo&& other);

    ExposureInfo(ExposureInfo const& other, bool copyMetadata);

    ExposureInfo& operator=(ExposureInfo const& other);
    ExposureInfo& operator=(ExposureInfo&& other);

    // Destructor defined in source file because we need access to destructors of forward-declared components
    ~ExposureInfo();

private:
    template <typename ImageT, typename MaskT, typename VarianceT>
    friend class Exposure;

    struct FitsWriteData {
        std::shared_ptr<daf::base::PropertyList> metadata;
        std::shared_ptr<daf::base::PropertyList> imageMetadata;
        std::shared_ptr<daf::base::PropertyList> maskMetadata;
        std::shared_ptr<daf::base::PropertyList> varianceMetadata;
        table::io::OutputArchive archive;
    };

    static int _addToArchive(FitsWriteData& data, table::io::Persistable const& object, std::string key,
                             std::string comment);

    static int _addToArchive(FitsWriteData& data, std::shared_ptr<table::io::Persistable const> const& object,
                             std::string key, std::string comment);

    FitsWriteData _startWriteFits(lsst::geom::Point2I const& xy0 = lsst::geom::Point2I()) const;

    void _finishWriteFits(fits::Fits& fitsfile, FitsWriteData const& data) const;

    static std::shared_ptr<ApCorrMap> _cloneApCorrMap(std::shared_ptr<ApCorrMap const> apCorrMap);

    // Implementation of setComponent
    template <class T>
    void _setComponent(typehandling::Key<std::string, std::shared_ptr<T>> const& key,
                       std::shared_ptr<T> const& object) {
        if (_components->contains(key)) {
            _components->erase(key);
        } else if (_components->contains(key.getId())) {
            std::stringstream buffer;
            buffer << "Map has a key that conflicts with " << key;
            throw LSST_EXCEPT(pex::exceptions::TypeError, buffer.str());
        }
        try {
            bool success = _components->insert(key, object);
            if (!success) {
                throw LSST_EXCEPT(
                        pex::exceptions::RuntimeError,
                        "Insertion failed for unknown reasons. There may be something in the logs.");
            }
        } catch (std::exception const& e) {
            std::throw_with_nested(
                    LSST_EXCEPT(pex::exceptions::RuntimeError, "Insertion raised an exception."));
        }
    }

    Filter _filter;
    std::shared_ptr<daf::base::PropertySet> _metadata;
    std::shared_ptr<image::VisitInfo const> _visitInfo;

    // Class invariant: all pointers in _components are not null
    std::unique_ptr<detail::StorableMap> _components;
};
}  // namespace image
}  // namespace afw
}  // namespace lsst

#endif  // !LSST_AFW_IMAGE_ExposureInfo_h_INCLUDED