CoaddBoundedField.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2014 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_MEAS_ALGORITHMS_CoaddBoundedField_h_INCLUDED
#define LSST_MEAS_ALGORITHMS_CoaddBoundedField_h_INCLUDED

#include "lsst/geom/Box.h"
#include "lsst/afw/math/BoundedField.h"
#include "lsst/afw/geom/SkyWcs.h"
#include "lsst/afw/geom/polygon/Polygon.h"

namespace lsst {
namespace meas {
namespace algorithms {

struct CoaddBoundedFieldElement {
    CoaddBoundedFieldElement(PTR(afw::math::BoundedField) field_, PTR(afw::geom::SkyWcs const) wcs_,
                             PTR(afw::geom::polygon::Polygon const) validPolygon_, double weight_ = 1.0)
            : field(field_), wcs(wcs_), validPolygon(validPolygon_), weight(weight_) {}

    bool operator==(CoaddBoundedFieldElement const& rhs) const;

    bool operator!=(CoaddBoundedFieldElement const& rhs) const { return !(*this == rhs); };

    PTR(afw::math::BoundedField) field;
    PTR(afw::geom::SkyWcs const) wcs;
    PTR(afw::geom::polygon::Polygon const) validPolygon;
    double weight;
};

class CoaddBoundedField : public afw::table::io::PersistableFacade<CoaddBoundedField>,
                          public afw::math::BoundedField {
public:
    typedef CoaddBoundedFieldElement Element;
    typedef std::vector<Element> ElementVector;

    explicit CoaddBoundedField(geom::Box2I const& bbox, PTR(afw::geom::SkyWcs const) coaddWcs,
                               ElementVector const& elements);

    explicit CoaddBoundedField(geom::Box2I const& bbox, PTR(afw::geom::SkyWcs const) coaddWcs,
                               ElementVector const& elements, double default_);

    double evaluate(geom::Point2D const& position) const override;

    std::shared_ptr<afw::geom::SkyWcs const> getCoaddWcs() const { return _coaddWcs; };

    double getDefault() const { return _default; };

    ElementVector getElements() const { return _elements; };

    virtual bool isPersistable() const noexcept override { return true; }

    // Factory used to read CoaddPsf from an InputArchive; defined only in the source file.
    class Factory;

    PTR(afw::math::BoundedField) operator*(double const scale) const override;

    bool operator==(BoundedField const& rhs) const override;

protected:
    // See afw::table::io::Persistable::getPersistenceName
    std::string getPersistenceName() const override;

    // See afw::table::io::Persistable::getPythonModule
    std::string getPythonModule() const override;

    // See afw::table::io::Persistable::write
    void write(OutputArchiveHandle& handle) const override;

private:
    bool _throwOnMissing;  // instead of using _default, raise an exception
    double _default;       // when none of the elements contribute at a point, return this value
    PTR(afw::geom::SkyWcs const) _coaddWcs;  // coordinate system this field is defined in
    ElementVector _elements;                 // vector of constituent fields being coadded

    std::string toString() const override {
        std::ostringstream os;
        os << "CoaddBoundedField with " << _elements.size() << " elements, default " << _default;
        return os.str();
    }
};

}  // namespace algorithms
}  // namespace meas
}  // namespace lsst

#endif  // !LSST_MEAS_ALGORITHMS_CoaddBoundedField_h_INCLUDED