Exposure.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010, 2011 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 AFW_TABLE_Exposure_h_INCLUDED
#define AFW_TABLE_Exposure_h_INCLUDED

#include "lsst/geom/Box.h"
#include "lsst/geom/SpherePoint.h"
#include "lsst/afw/fitsDefaults.h"
#include "lsst/afw/table/BaseRecord.h"
#include "lsst/afw/table/BaseTable.h"
#include "lsst/afw/table/SortedCatalog.h"
#include "lsst/afw/table/BaseColumnView.h"
#include "lsst/afw/table/io/FitsWriter.h"
#include "lsst/afw/table/aggregates.h"

namespace lsst {
namespace afw {

namespace image {
class PhotoCalib;
class ApCorrMap;
class VisitInfo;
class TransmissionCurve;
}  // namespace image

namespace detection {
class Psf;
}  // namespace detection

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

namespace cameraGeom {
class Detector;
}  // namespace cameraGeom

namespace table {

class ExposureRecord;
class ExposureTable;

template <typename RecordT>
class ExposureCatalogT;

namespace io {

class OutputArchiveHandle;
class InputArchive;

}  // namespace io

class ExposureRecord : public BaseRecord {
public:
    typedef ExposureTable Table;
    typedef ColumnViewT<ExposureRecord> ColumnView;
    typedef ExposureCatalogT<ExposureRecord> Catalog;
    typedef ExposureCatalogT<ExposureRecord const> ConstCatalog;

    ExposureRecord(ConstructionToken const & token, detail::RecordData && data) :
        BaseRecord(token, std::move(data))
    {}

    std::shared_ptr<ExposureTable const> getTable() const {
        return std::static_pointer_cast<ExposureTable const>(BaseRecord::getTable());
    }

    RecordId getId() const;
    void setId(RecordId id);

    lsst::geom::Box2I getBBox() const;
    void setBBox(lsst::geom::Box2I const& bbox);

    bool contains(lsst::geom::SpherePoint const& coord, bool includeValidPolygon = false) const;

    bool contains(lsst::geom::Point2D const& point, geom::SkyWcs const& wcs,
                  bool includeValidPolygon = false) const;

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

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

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

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

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

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

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

    std::shared_ptr<image::TransmissionCurve const> getTransmissionCurve() const {
        return _transmissionCurve;
    }
    void setTransmissionCurve(std::shared_ptr<image::TransmissionCurve const> transmissionCurve) {
        _transmissionCurve = std::move(transmissionCurve);
    }

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

    ExposureRecord(ExposureRecord const&) = delete;
    ExposureRecord(ExposureRecord&&) = delete;
    ExposureRecord& operator=(ExposureRecord const&) = delete;
    ExposureRecord& operator=(ExposureRecord&&) = delete;
    ~ExposureRecord() override;

protected:

    void _assign(BaseRecord const& other) override;

private:
    friend class ExposureTable;

    std::shared_ptr<geom::SkyWcs const> _wcs;
    std::shared_ptr<detection::Psf const> _psf;
    std::shared_ptr<image::PhotoCalib const> _photoCalib;
    std::shared_ptr<image::ApCorrMap const> _apCorrMap;
    std::shared_ptr<geom::polygon::Polygon const> _validPolygon;
    std::shared_ptr<image::VisitInfo const> _visitInfo;
    std::shared_ptr<image::TransmissionCurve const> _transmissionCurve;
    std::shared_ptr<cameraGeom::Detector const> _detector;
};

class ExposureTable : public BaseTable {
public:
    typedef ExposureRecord Record;
    typedef ColumnViewT<ExposureRecord> ColumnView;
    typedef ExposureCatalogT<Record> Catalog;
    typedef ExposureCatalogT<Record const> ConstCatalog;

    static std::shared_ptr<ExposureTable> make(Schema const& schema);

    static Schema makeMinimalSchema() {
        Schema r = getMinimalSchema().schema;
        r.disconnectAliases();
        return r;
    }

    static bool checkSchema(Schema const& other) { return other.contains(getMinimalSchema().schema); }


    static Key<RecordId> getIdKey() { return getMinimalSchema().id; }
    static PointKey<int> getBBoxMinKey() { return getMinimalSchema().bbox.getMin(); }
    static PointKey<int> getBBoxMaxKey() { return getMinimalSchema().bbox.getMax(); }
    static Box2IKey getBBoxKey() { return getMinimalSchema().bbox; }

    std::shared_ptr<ExposureTable> clone() const { return std::static_pointer_cast<ExposureTable>(_clone()); }

    std::shared_ptr<ExposureRecord> makeRecord() {
        return std::static_pointer_cast<ExposureRecord>(_makeRecord());
    }

    std::shared_ptr<ExposureRecord> copyRecord(BaseRecord const& other) {
        return std::static_pointer_cast<ExposureRecord>(BaseTable::copyRecord(other));
    }

    std::shared_ptr<ExposureRecord> copyRecord(BaseRecord const& other, SchemaMapper const& mapper) {
        return std::static_pointer_cast<ExposureRecord>(BaseTable::copyRecord(other, mapper));
    }

    ExposureTable& operator=(ExposureTable const&) = delete;
    ExposureTable& operator=(ExposureTable&&) = delete;
    ~ExposureTable() override;

protected:
    explicit ExposureTable(Schema const& schema);

    ExposureTable(ExposureTable const& other);
    ExposureTable(ExposureTable&& other);

    std::shared_ptr<BaseTable> _clone() const override;

    std::shared_ptr<BaseRecord> _makeRecord() override;

private:
    // Struct that holds the minimal schema and the special keys we've added to it.
    struct MinimalSchema {
        Schema schema;
        Key<RecordId> id;
        Box2IKey bbox;

        MinimalSchema();
    };

    // Return the singleton minimal schema.
    static MinimalSchema& getMinimalSchema();

    friend class io::FitsWriter;

    template <typename RecordT>
    friend class ExposureCatalogT;

    // Return a writer object that knows how to save in FITS format.  See also FitsWriter.
    std::shared_ptr<io::FitsWriter> makeFitsWriter(fits::Fits* fitsfile, int flags) const override;

    std::shared_ptr<io::FitsWriter> makeFitsWriter(fits::Fits* fitsfile,
                                                   std::shared_ptr<io::OutputArchive> archive,
                                                   int flags) const;
};

template <typename RecordT>
class ExposureCatalogT : public SortedCatalogT<RecordT> {
    typedef SortedCatalogT<RecordT> Base;

public:
    typedef RecordT Record;
    typedef typename Record::Table Table;

    typedef typename Base::iterator iterator;
    typedef typename Base::const_iterator const_iterator;

    explicit ExposureCatalogT(std::shared_ptr<Table> const& table = std::shared_ptr<Table>()) : Base(table) {}

    explicit ExposureCatalogT(Schema const& schema) : Base(schema) {}

    template <typename InputIterator>
    ExposureCatalogT(std::shared_ptr<Table> const& table, InputIterator first, InputIterator last,
                     bool deep = false)
            : Base(table, first, last, deep) {}

    template <typename OtherRecordT>
    ExposureCatalogT(ExposureCatalogT<OtherRecordT> const& other) : Base(other) {}

    ExposureCatalogT(ExposureCatalogT const&) = default;
    ExposureCatalogT(ExposureCatalogT&&) = default;
    ExposureCatalogT& operator=(ExposureCatalogT const&) = default;
    ExposureCatalogT& operator=(ExposureCatalogT&&) = default;
    ~ExposureCatalogT() = default;

    using Base::writeFits;

    void writeFits(fits::Fits& fitsfile, std::shared_ptr<io::OutputArchive> archive, int flags = 0) const {
        std::shared_ptr<io::FitsWriter> writer = this->getTable()->makeFitsWriter(&fitsfile, archive, flags);
        writer->write(*this);
    }

    static ExposureCatalogT readFits(std::string const& filename, int hdu = fits::DEFAULT_HDU,
                                     int flags = 0) {
        return io::FitsReader::apply<ExposureCatalogT>(filename, hdu, flags);
    }

    static ExposureCatalogT readFits(fits::MemFileManager& manager, int hdu = fits::DEFAULT_HDU,
                                     int flags = 0) {
        return io::FitsReader::apply<ExposureCatalogT>(manager, hdu, flags);
    }

    static ExposureCatalogT readFits(fits::Fits& fitsfile, int flags = 0) {
        return io::FitsReader::apply<ExposureCatalogT>(fitsfile, flags);
    }

    static ExposureCatalogT readFits(fits::Fits& fitsfile, std::shared_ptr<io::InputArchive> archive,
                                     int flags = 0) {
        return io::FitsReader::apply<ExposureCatalogT>(fitsfile, flags, archive);
    }

    void writeToArchive(io::OutputArchiveHandle& handle, bool ignoreUnpersistable = true) const;

    static ExposureCatalogT readFromArchive(io::InputArchive const& archive, BaseCatalog const& catalog);

    ExposureCatalogT<RecordT> subset(ndarray::Array<bool const, 1> const& mask) const {
        return ExposureCatalogT(Base::subset(mask));
    }

    ExposureCatalogT subset(std::ptrdiff_t startd, std::ptrdiff_t stopd, std::ptrdiff_t step) const {
        return ExposureCatalogT(Base::subset(startd, stopd, step));
    }

    ExposureCatalogT subsetContaining(lsst::geom::SpherePoint const& coord,
                                      bool includeValidPolygon = false) const;

    ExposureCatalogT subsetContaining(lsst::geom::Point2D const& point, geom::SkyWcs const& wcs,
                                      bool includeValidPolygon = false) const;

protected:
    explicit ExposureCatalogT(Base const& other) : Base(other) {}
};

typedef ColumnViewT<ExposureRecord> ExposureColumnView;
typedef ExposureCatalogT<ExposureRecord> ExposureCatalog;
typedef ExposureCatalogT<ExposureRecord const> ConstExposureCatalog;

inline RecordId ExposureRecord::getId() const { return get(ExposureTable::getIdKey()); }
inline void ExposureRecord::setId(RecordId id) { set(ExposureTable::getIdKey(), id); }
}  // namespace table
}  // namespace afw
}  // namespace lsst

#endif  // !AFW_TABLE_Exposure_h_INCLUDED