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/afw/geom/Box.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 Wcs;
class Calib;
class ApCorrMap;
class VisitInfo;
} // namespace image

namespace detection {
class Psf;
} // namespace detection

namespace geom { namespace polygon {
class Polygon;
}}

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;

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

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

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

    bool contains(Coord const & coord, bool includeValidPolygon=false) const;

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

    CONST_PTR(image::Wcs) getWcs() const { return _wcs; }
    void setWcs(CONST_PTR(image::Wcs) wcs) { _wcs = wcs; }

    CONST_PTR(detection::Psf) getPsf() const { return _psf; }
    void setPsf(CONST_PTR(detection::Psf) psf) { _psf = psf; }

    CONST_PTR(image::Calib) getCalib() const { return _calib; }
    void setCalib(CONST_PTR(image::Calib) calib) { _calib = calib; }

    CONST_PTR(image::ApCorrMap) getApCorrMap() const { return _apCorrMap; }
    void setApCorrMap(CONST_PTR(image::ApCorrMap) apCorrMap) { _apCorrMap = apCorrMap; }

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

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

protected:

    ExposureRecord(PTR(ExposureTable) const & table);

    virtual void _assign(BaseRecord const & other);

private:
    CONST_PTR(image::Wcs) _wcs;
    CONST_PTR(detection::Psf) _psf;
    CONST_PTR(image::Calib) _calib;
    CONST_PTR(image::ApCorrMap) _apCorrMap;
    CONST_PTR(geom::polygon::Polygon) _validPolygon;
    CONST_PTR(image::VisitInfo) _visitInfo;
};

class ExposureTable : public BaseTable {
public:

    typedef ExposureRecord Record;
    typedef ColumnViewT<ExposureRecord> ColumnView;
    typedef ExposureCatalogT<Record> Catalog;
    typedef ExposureCatalogT<Record const> ConstCatalog;

    static 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().bboxMin; }
    static PointKey<int> getBBoxMaxKey() { return getMinimalSchema().bboxMax; }

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

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

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

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

protected:

    ExposureTable(Schema const & schema);

    ExposureTable(ExposureTable const & other);

private:

    // Struct that holds the minimal schema and the special keys we've added to it.
    struct MinimalSchema {
        Schema schema;
        Key<RecordId> id;
        PointKey<int> bboxMin;
        PointKey<int> bboxMax;

        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.
    virtual PTR(io::FitsWriter) makeFitsWriter(fits::Fits * fitsfile, int flags) const;
    PTR(io::FitsWriter) makeFitsWriter(
        fits::Fits * fitsfile, PTR(io::OutputArchive) archive, int flags
    ) const;
};

#ifndef SWIG

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(PTR(Table) const & table = PTR(Table)()) : Base(table) {}

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

    template <typename InputIterator>
    ExposureCatalogT(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) {}

    using Base::writeFits;

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

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

    static ExposureCatalogT readFits(fits::MemFileManager & manager, int hdu=0, 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, 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(Coord const & coord, bool includeValidPolygon=false) const;

    ExposureCatalogT subsetContaining(geom::Point2D const & point, image::Wcs 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); }

#endif // !SWIG

}}} // namespace lsst::afw::table

#endif // !AFW_TABLE_Exposure_h_INCLUDED