CoaddBoundedField.cc

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2014, 2010 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/>.
 */

#include "lsst/pex/exceptions/Runtime.h"
#include "lsst/geom/Box.h"
#include "lsst/afw/table/io/CatalogVector.h"
#include "lsst/afw/table/io/OutputArchive.h"
#include "lsst/afw/table/io/InputArchive.h"
#include "lsst/afw/table/io/Persistable.cc"
#include "lsst/afw/table/aggregates.h"
#include "lsst/meas/algorithms/CoaddBoundedField.h"

namespace lsst {
namespace afw {
namespace table {
namespace io {

template std::shared_ptr<meas::algorithms::CoaddBoundedField>
PersistableFacade<meas::algorithms::CoaddBoundedField>::dynamicCast(std::shared_ptr<Persistable> const&);

}  // namespace io
}  // namespace table
}  // namespace afw
namespace meas {
namespace algorithms {
namespace {

/*
 * Compare two pointers of the same type
 *
 * If both pointers are set then return *a == *b
 * else return a == b
 */
template <typename T>
bool ptrEquals(T a, T b) {
    if (a == b) {
        // test this first for efficiency
        return true;
    } else if (a && b) {
        // both pointers are set, so it is safe to check value equality
        return *a == *b;
    }
    return false;
}

}  // namespace

bool CoaddBoundedFieldElement::operator==(CoaddBoundedFieldElement const& rhs) const {
    return ptrEquals(field, rhs.field) && ptrEquals(wcs, rhs.wcs) &&
           ptrEquals(validPolygon, rhs.validPolygon) && (weight == rhs.weight);
}

CoaddBoundedField::CoaddBoundedField(geom::Box2I const& bbox, PTR(afw::geom::SkyWcs const) coaddWcs,
                                     ElementVector const& elements)
        : afw::math::BoundedField(bbox),
          _throwOnMissing(true),
          _default(0.0),  // unused
          _coaddWcs(coaddWcs),
          _elements(elements) {}

CoaddBoundedField::CoaddBoundedField(geom::Box2I const& bbox, PTR(afw::geom::SkyWcs const) coaddWcs,
                                     ElementVector const& elements, double default_)
        : afw::math::BoundedField(bbox),
          _throwOnMissing(false),
          _default(default_),
          _coaddWcs(coaddWcs),
          _elements(elements) {}

double CoaddBoundedField::evaluate(geom::Point2D const& position) const {
    auto coord = _coaddWcs->pixelToSky(position);
    double sum = 0.0;
    double wSum = 0.0;
    for (ElementVector::const_iterator i = _elements.begin(); i != _elements.end(); ++i) {
        geom::Point2D transformedPosition = i->wcs->skyToPixel(coord);
        bool inValidArea = i->validPolygon ? i->validPolygon->contains(transformedPosition) : true;
        if (geom::Box2D(i->field->getBBox()).contains(transformedPosition) && inValidArea) {
            sum += i->weight * i->field->evaluate(transformedPosition);
            wSum += i->weight;
        }
    }
    if (wSum == 0.0) {
        if (_throwOnMissing) {
            throw LSST_EXCEPT(pex::exceptions::DomainError,
                              (boost::format("No constituent fields to evaluate at point %f, %f") %
                               position.getX() % position.getY())
                                      .str());
        } else {
            return _default;
        }
    }
    return sum / wSum;
}

// ---------- Persistence -----------------------------------------------------------------------------------

// For persistence of CoaddBoundedField, we have two catalogs: the first has just one record, and contains
// the archive ID of the coadd WCS and the parameters that control missing data.  The other catalog
// has one record for each element, with fields corresponding to the data members of the Element struct.

namespace {

// Singleton class that manages the first persistence catalog's schema and keys
class CoaddBoundedFieldPersistenceKeys1 {
public:
    afw::table::Schema schema;
    afw::table::PointKey<int> bboxMin;
    afw::table::PointKey<int> bboxMax;
    afw::table::Key<int> coaddWcs;
    afw::table::Key<afw::table::Flag> throwOnMissing;
    afw::table::Key<double> default_;

    static CoaddBoundedFieldPersistenceKeys1 const& get() {
        static CoaddBoundedFieldPersistenceKeys1 const instance;
        return instance;
    }

    // No copying
    CoaddBoundedFieldPersistenceKeys1(const CoaddBoundedFieldPersistenceKeys1&) = delete;
    CoaddBoundedFieldPersistenceKeys1& operator=(const CoaddBoundedFieldPersistenceKeys1&) = delete;

    // No moving
    CoaddBoundedFieldPersistenceKeys1(CoaddBoundedFieldPersistenceKeys1&&) = delete;
    CoaddBoundedFieldPersistenceKeys1& operator=(CoaddBoundedFieldPersistenceKeys1&&) = delete;

private:
    CoaddBoundedFieldPersistenceKeys1()
            : schema(),
              bboxMin(afw::table::PointKey<int>::addFields(schema, "bbox_min",
                                                           "lower-left corner of bounding box", "pixel")),
              bboxMax(afw::table::PointKey<int>::addFields(schema, "bbox_max",
                                                           "upper-right corner of bounding box", "pixel")),
              coaddWcs(schema.addField<int>("coaddWcs", "archive ID of the coadd's WCS")),
              throwOnMissing(schema.addField<afw::table::Flag>(
                      "throwOnMissing", "whether to throw an exception on missing data")),
              default_(schema.addField<double>("default",
                                               "default value to use when throwOnMissing is False")) {}
};

// Singleton class that manages the second persistence catalog's schema and keys
class CoaddBoundedFieldPersistenceKeys2 {
public:
    afw::table::Schema schema;
    afw::table::Key<int> field;
    afw::table::Key<int> wcs;
    afw::table::Key<int> validPolygon;
    afw::table::Key<double> weight;

    static CoaddBoundedFieldPersistenceKeys2 const& get() {
        static CoaddBoundedFieldPersistenceKeys2 const instance;
        return instance;
    }

    // No copying
    CoaddBoundedFieldPersistenceKeys2(const CoaddBoundedFieldPersistenceKeys2&) = delete;
    CoaddBoundedFieldPersistenceKeys2& operator=(const CoaddBoundedFieldPersistenceKeys2&) = delete;

    // No moving
    CoaddBoundedFieldPersistenceKeys2(CoaddBoundedFieldPersistenceKeys2&&) = delete;
    CoaddBoundedFieldPersistenceKeys2& operator=(CoaddBoundedFieldPersistenceKeys2&&) = delete;

private:
    CoaddBoundedFieldPersistenceKeys2()
            : schema(),
              field(schema.addField<int>("field", "archive ID of the BoundedField to be coadded")),
              wcs(schema.addField<int>("wcs", "archive ID of the Wcs associated with this element")),
              validPolygon(schema.addField<int>("validPolygon",
                                                "archive ID of the Polygon associated with this element")),
              weight(schema.addField<double>("weight", "weight value for this element")) {}
};

}  // namespace

class CoaddBoundedField::Factory : public afw::table::io::PersistableFactory {
public:
    virtual PTR(afw::table::io::Persistable)
            read(InputArchive const& archive, CatalogVector const& catalogs) const {
        CoaddBoundedFieldPersistenceKeys1 const& keys1 = CoaddBoundedFieldPersistenceKeys1::get();
        CoaddBoundedFieldPersistenceKeys2 const& keys2 = CoaddBoundedFieldPersistenceKeys2::get();
        LSST_ARCHIVE_ASSERT(catalogs.size() == 2u);
        LSST_ARCHIVE_ASSERT(catalogs.front().getSchema() == keys1.schema);
        LSST_ARCHIVE_ASSERT(catalogs.back().getSchema() == keys2.schema);
        afw::table::BaseRecord const& record1 = catalogs.front().front();
        ElementVector elements;
        elements.reserve(catalogs.back().size());
        for (afw::table::BaseCatalog::const_iterator i = catalogs.back().begin(); i != catalogs.back().end();
             ++i) {
            elements.push_back(Element(archive.get<afw::math::BoundedField>(i->get(keys2.field)),
                                       archive.get<afw::geom::SkyWcs>(i->get(keys2.wcs)),
                                       archive.get<afw::geom::polygon::Polygon>(i->get(keys2.validPolygon)),
                                       i->get(keys2.weight)));
        }
        return std::make_shared<CoaddBoundedField>(
                geom::Box2I(record1.get(keys1.bboxMin), record1.get(keys1.bboxMax)),
                archive.get<afw::geom::SkyWcs>(record1.get(keys1.coaddWcs)), elements,
                record1.get(keys1.default_));
    }

    Factory(std::string const& name) : afw::table::io::PersistableFactory(name) {}
};

namespace {

std::string getCoaddBoundedFieldPersistenceName() { return "CoaddBoundedField"; }

CoaddBoundedField::Factory registration(getCoaddBoundedFieldPersistenceName());

}  // namespace

std::string CoaddBoundedField::getPersistenceName() const { return getCoaddBoundedFieldPersistenceName(); }

std::string CoaddBoundedField::getPythonModule() const { return "lsst.meas.algorithms"; }

void CoaddBoundedField::write(OutputArchiveHandle& handle) const {
    CoaddBoundedFieldPersistenceKeys1 const& keys1 = CoaddBoundedFieldPersistenceKeys1::get();
    CoaddBoundedFieldPersistenceKeys2 const& keys2 = CoaddBoundedFieldPersistenceKeys2::get();
    afw::table::BaseCatalog cat1 = handle.makeCatalog(keys1.schema);
    PTR(afw::table::BaseRecord) record1 = cat1.addNew();
    record1->set(keys1.bboxMin, getBBox().getMin());
    record1->set(keys1.bboxMax, getBBox().getMax());
    record1->set(keys1.coaddWcs, handle.put(_coaddWcs));
    record1->set(keys1.default_, _default);
    handle.saveCatalog(cat1);
    afw::table::BaseCatalog cat2 = handle.makeCatalog(keys2.schema);
    for (ElementVector::const_iterator i = _elements.begin(); i != _elements.end(); ++i) {
        PTR(afw::table::BaseRecord) record2 = cat2.addNew();
        record2->set(keys2.field, handle.put(i->field));
        record2->set(keys2.wcs, handle.put(i->wcs));
        record2->set(keys2.validPolygon, handle.put(i->validPolygon));
        record2->set(keys2.weight, i->weight);
    }
    handle.saveCatalog(cat2);
}

PTR(afw::math::BoundedField) CoaddBoundedField::operator*(double const scale) const {
    throw LSST_EXCEPT(pex::exceptions::NotFoundError, "Scaling of CoaddBoundedField is not implemented");
}

bool CoaddBoundedField::operator==(BoundedField const& rhs) const {
    auto rhsCasted = dynamic_cast<CoaddBoundedField const*>(&rhs);
    if (!rhsCasted) return false;

    return (getBBox() == rhsCasted->getBBox()) && (_default == rhsCasted->_default) &&
           ptrEquals(_coaddWcs, rhsCasted->_coaddWcs) && (_elements == rhsCasted->_elements);
}

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