ExposureInfo.h

Go to the documentation of this file.

// -*- LSST-C++ -*- // fixed format comment for emacs
/*
 * LSST Data Management System
 * Copyright 2008-2013 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#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"

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:
    bool hasWcs() const { return static_cast<bool>(_wcs); }

    std::shared_ptr<geom::SkyWcs const> getWcs() const { return _wcs; }

    void setWcs(std::shared_ptr<geom::SkyWcs const> wcs) { _wcs = wcs; }

    bool hasDetector() const { return static_cast<bool>(_detector); }

    std::shared_ptr<cameraGeom::Detector const> getDetector() const { return _detector; }

    void setDetector(std::shared_ptr<cameraGeom::Detector const> detector) { _detector = detector; }

    Filter getFilter() const { return _filter; }

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

    bool hasPhotoCalib() const { return static_cast<bool>(_photoCalib); }

    std::shared_ptr<PhotoCalib const> getPhotoCalib() const { return _photoCalib; }

    void setPhotoCalib(std::shared_ptr<PhotoCalib const> photoCalib) { _photoCalib = photoCalib; }

    [[deprecated("Replaced with hasPhotoCalib (will be removed in 18.0)")]] bool hasCalib() const {
        return static_cast<bool>(_photoCalib);
    }

    [[deprecated("Replaced with getPhotoCalib (will be removed in 18.0)")]] std::shared_ptr<PhotoCalib const>
    getCalib() const {
        return _photoCalib;
    }

    [[deprecated("Replaced with setPhotoCalib (will be removed in 18.0)")]] void setCalib(
            std::shared_ptr<PhotoCalib const> photoCalib) {
        _photoCalib = 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 { return static_cast<bool>(_psf); }

    std::shared_ptr<detection::Psf> getPsf() const { return _psf; }

    void setPsf(std::shared_ptr<detection::Psf const> psf) {
        // Psfs are immutable, so this is always safe; it'd be better to always just pass around
        // const or non-const pointers, instead of both, but this is more backwards-compatible.
        _psf = std::const_pointer_cast<detection::Psf>(psf);
    }

    bool hasValidPolygon() const { return static_cast<bool>(_validPolygon); }

    std::shared_ptr<geom::polygon::Polygon const> getValidPolygon() const { return _validPolygon; }

    void setValidPolygon(std::shared_ptr<geom::polygon::Polygon const> polygon) { _validPolygon = polygon; }

    bool hasApCorrMap() const { return static_cast<bool>(_apCorrMap); }

    std::shared_ptr<ApCorrMap> getApCorrMap() { return _apCorrMap; }

    std::shared_ptr<ApCorrMap const> getApCorrMap() const { return _apCorrMap; }

    void setApCorrMap(std::shared_ptr<ApCorrMap> apCorrMap) { _apCorrMap = apCorrMap; }

    void initApCorrMap();

    bool hasCoaddInputs() const { return static_cast<bool>(_coaddInputs); }

    void setCoaddInputs(std::shared_ptr<CoaddInputs> coaddInputs) { _coaddInputs = coaddInputs; }

    std::shared_ptr<CoaddInputs> getCoaddInputs() const { return _coaddInputs; }

    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 { return static_cast<bool>(_transmissionCurve); }

    std::shared_ptr<TransmissionCurve const> getTransmissionCurve() const { return _transmissionCurve; }

    void setTransmissionCurve(std::shared_ptr<TransmissionCurve const> tc) { _transmissionCurve = tc; }

    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;
    };

    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);

    std::shared_ptr<geom::SkyWcs const> _wcs;
    std::shared_ptr<detection::Psf> _psf;
    std::shared_ptr<PhotoCalib const> _photoCalib;
    std::shared_ptr<cameraGeom::Detector const> _detector;
    std::shared_ptr<geom::polygon::Polygon const> _validPolygon;
    Filter _filter;
    std::shared_ptr<daf::base::PropertySet> _metadata;
    std::shared_ptr<CoaddInputs> _coaddInputs;
    std::shared_ptr<ApCorrMap> _apCorrMap;
    std::shared_ptr<image::VisitInfo const> _visitInfo;
    std::shared_ptr<TransmissionCurve const> _transmissionCurve;
};
}  // namespace image
}  // namespace afw
}  // namespace lsst

#endif  // !LSST_AFW_IMAGE_ExposureInfo_h_INCLUDED