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

namespace fits {
class Fits;
}

namespace image {

class Calib;
class Wcs;
class ApCorrMap;
class VisitInfo;

class ExposureInfo {
public:

    bool hasWcs() const { return static_cast<bool>(_wcs); }

    PTR(Wcs) getWcs() { return _wcs; }

    CONST_PTR(Wcs) getWcs() const { return _wcs; }

    void setWcs(CONST_PTR(Wcs) wcs) { _wcs = _cloneWcs(wcs); }

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

    CONST_PTR(cameraGeom::Detector) getDetector() const { return _detector; }

    void setDetector(CONST_PTR(cameraGeom::Detector) detector) { _detector = detector; }

    Filter getFilter() const { return _filter; }

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

    bool hasCalib() const { return static_cast<bool>(_calib); }

    PTR(Calib) getCalib() { return _calib; }

    CONST_PTR(Calib) getCalib() const { return _calib; }

    void setCalib(CONST_PTR(Calib) calib) { _calib = _cloneCalib(calib); }

    PTR(daf::base::PropertySet) getMetadata() const { return _metadata; }

    void setMetadata(PTR(daf::base::PropertySet) metadata) { _metadata = metadata; }

    bool hasPsf() const { return static_cast<bool>(_psf); }

    PTR(detection::Psf) getPsf() const { return _psf; }

    void setPsf(CONST_PTR(detection::Psf) 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);}

    CONST_PTR(geom::polygon::Polygon) getValidPolygon() const { return _validPolygon;}

    void setValidPolygon(CONST_PTR(geom::polygon::Polygon) polygon) { _validPolygon = polygon; }

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

    PTR(ApCorrMap) getApCorrMap() { return _apCorrMap; }

    PTR(ApCorrMap const) getApCorrMap() const { return _apCorrMap; }

    void setApCorrMap(PTR(ApCorrMap) apCorrMap) { _apCorrMap = apCorrMap; }

    void initApCorrMap();

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

    void setCoaddInputs(PTR(CoaddInputs) coaddInputs) { _coaddInputs = coaddInputs; }

    PTR(CoaddInputs) getCoaddInputs() const { return _coaddInputs; }

    CONST_PTR(image::VisitInfo) getVisitInfo() const { return _visitInfo; }

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

    void setVisitInfo(CONST_PTR(image::VisitInfo) const visitInfo) { _visitInfo = visitInfo; }

    explicit ExposureInfo(
        CONST_PTR(Wcs) const & wcs = CONST_PTR(Wcs)(),
        CONST_PTR(detection::Psf) const & psf = CONST_PTR(detection::Psf)(),
        CONST_PTR(Calib) const & calib = CONST_PTR(Calib)(),
        CONST_PTR(cameraGeom::Detector) const & detector = CONST_PTR(cameraGeom::Detector)(),
        CONST_PTR(geom::polygon::Polygon) const & polygon = CONST_PTR(geom::polygon::Polygon)(),
        Filter const & filter = Filter(),
        PTR(daf::base::PropertySet) const & metadata = PTR(daf::base::PropertySet)(),
        PTR(CoaddInputs) const & coaddInputs = PTR(CoaddInputs)(),
        PTR(ApCorrMap) const & apCorrMap = PTR(ApCorrMap)(),
        CONST_PTR(image::VisitInfo) const & visitInfo = CONST_PTR(image::VisitInfo)()
    );

    ExposureInfo(ExposureInfo const & other);

    ExposureInfo(ExposureInfo const & other, bool copyMetadata);

    ExposureInfo & operator=(ExposureInfo const & 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 {
        PTR(daf::base::PropertyList) metadata;
        PTR(daf::base::PropertyList) imageMetadata;
        PTR(daf::base::PropertyList) maskMetadata;
        PTR(daf::base::PropertyList) varianceMetadata;
        table::io::OutputArchive archive;
    };

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

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

    void _readFits(
        fits::Fits & fitsfile,
        PTR(daf::base::PropertySet) metadata,
        PTR(daf::base::PropertySet) imageMetadata
    );

    static PTR(Calib) _cloneCalib(CONST_PTR(Calib) calib);
    static PTR(Wcs) _cloneWcs(CONST_PTR(Wcs) wcs);
    static PTR(ApCorrMap) _cloneApCorrMap(PTR(ApCorrMap const) apCorrMap);

    PTR(Wcs) _wcs;
    PTR(detection::Psf) _psf;
    PTR(Calib) _calib;
    CONST_PTR(cameraGeom::Detector) _detector;
    CONST_PTR(geom::polygon::Polygon) _validPolygon;
    Filter _filter;
    PTR(daf::base::PropertySet) _metadata;
    PTR(CoaddInputs) _coaddInputs;
    PTR(ApCorrMap) _apCorrMap;
    CONST_PTR(image::VisitInfo) _visitInfo;
};

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

#endif // !LSST_AFW_IMAGE_ExposureInfo_h_INCLUDED