centroidUtilities.cc

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2008-2017  AURA/LSST.
 *
 * 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 <https://www.lsstcorp.org/LegalNotices/>.
 */
 
#include "pybind11/pybind11.h"
#include "pybind11/eigen.h"
#include "lsst/cpputils/python.h"
 
#include <memory>
 
#include "lsst/meas/base/CentroidUtilities.h"
 
namespace py = pybind11;
using namespace pybind11::literals;
 
namespace lsst {
namespace meas {
namespace base {
 
namespace {
 
using PyCentroidChecker = py::class_<CentroidChecker>;
using PyCentroidResult = py::classh<CentroidResult>;
using PyCentroidResultKey = py::classh<CentroidResultKey>;
using PyCentroidTransform = py::classh<CentroidTransform, BaseTransform>;
 
void declareCentroidResult(lsst::cpputils::python::WrapperCollection &wrappers) {
    wrappers.wrapType(PyCentroidResult(wrappers.module, "CentroidResult"), [](auto &mod, auto &cls) {
        cls.def_readwrite("x", &CentroidResult::x);
        cls.def_readwrite("y", &CentroidResult::y);
        cls.def_readwrite("xErr", &CentroidResult::xErr);
        cls.def_readwrite("yErr", &CentroidResult::yErr);
        cls.def_readwrite("x_y_Cov", &CentroidResult::x_y_Cov);
 
        cls.def(py::init<>());
        cls.def(py::init<CentroidElement, CentroidElement, CentroidCov const &>(), "x"_a, "y"_a, "matrix"_a);
        cls.def(py::init<CentroidElement, CentroidElement, ErrElement, ErrElement>(), "x"_a, "y"_a, "xErr"_a,
                "yErr"_a);
 
        cls.def("getCentroid", &CentroidResult::getCentroid);
        cls.def("setCentroid", &CentroidResult::setCentroid, "centroid"_a);
        cls.def("getPoint", &CentroidResult::getPoint);
        cls.def("getCentroidErr", &CentroidResult::getCentroidErr);
        cls.def("setCentroidErr",
                (void(CentroidResult::*)(CentroidCov const &)) & CentroidResult::setCentroidErr, "matrix"_a);
        cls.def("setCentroidErr",
                (void(CentroidResult::*)(ErrElement, ErrElement)) & CentroidResult::setCentroidErr, "xErr"_a,
                "yErr"_a);
        cpputils::python::addOutputOp(cls, "__str__");
        cpputils::python::addOutputOp(cls, "__repr__");
    });
}
 
void declareCentroidResultKey(lsst::cpputils::python::WrapperCollection &wrappers) {
    wrappers.wrapType(PyCentroidResultKey(wrappers.module, "CentroidResultKey"), [](auto &mod, auto &cls) {
        cls.def(py::init<>());
        cls.def(py::init<afw::table::PointKey<CentroidElement> const &,
                         afw::table::CovarianceMatrixKey<ErrElement, 2> const &>(),
                "centroid"_a, "uncertainty"_a);
        cls.def(py::init<afw::table::SubSchema const &>(), "subSchema"_a);
 
        cls.def_static("addFields", &CentroidResultKey::addFields, "schema"_a, "name"_a, "doc"_a,
                       "uncertainty"_a);
 
        cls.def("__eq__", &CentroidResultKey::operator==, py::is_operator());
        cls.def("__nq__", &CentroidResultKey::operator!=, py::is_operator());
 
        cls.def("get", &CentroidResultKey::get, "record"_a);
        cls.def("set", &CentroidResultKey::set, "record"_a, "value"_a);
        cls.def("isValid", &CentroidResultKey::isValid);
        cls.def("getCentroid", &CentroidResultKey::getCentroid);
        cls.def("getCentroidErr", &CentroidResultKey::getCentroidErr);
        cls.def("getX", &CentroidResultKey::getX);
        cls.def("getY", &CentroidResultKey::getY);
    });
}
 
void declareCentroidTransform(lsst::cpputils::python::WrapperCollection &wrappers) {
    wrappers.wrapType(PyCentroidTransform(wrappers.module, "CentroidTransform"), [](auto &mod, auto &cls) {
        cls.def(py::init<std::string const &, afw::table::SchemaMapper &>(), "name"_a, "mapper"_a);
 
        cls.def("__call__", &CentroidTransform::operator(), "inputCatalog"_a, "outputCatalog"_a, "wcs"_a,
                "photoCalib"_a);
    });
}
 
void declareCentroidChecker(lsst::cpputils::python::WrapperCollection &wrappers) {
    wrappers.wrapType(PyCentroidChecker(wrappers.module, "CentroidChecker"), [](auto &mod, auto &cls) {
        cls.def(py::init<afw::table::Schema &, std::string const &, bool, double>(), "schema"_a, "name"_a,
                "inside"_a = true, "maxDistFromPeak"_a = -1.0);
 
        cls.def("__call__", &CentroidChecker::operator(), "record"_a);
    });
}
 
void declareUncertaintyEnum(lsst::cpputils::python::WrapperCollection &wrappers) {
    wrappers.wrapType(py::enum_<UncertaintyEnum>(wrappers.module, "UncertaintyEnum"),
                      [](auto &mod, auto &enm) {
                          enm.value("NO_UNCERTAINTY", UncertaintyEnum::NO_UNCERTAINTY);
                          enm.value("SIGMA_ONLY", UncertaintyEnum::SIGMA_ONLY);
                          enm.value("FULL_COVARIANCE", UncertaintyEnum::FULL_COVARIANCE);
                      });
}
 
}  // namespace
 
void wrapCentroidUtilities(lsst::cpputils::python::WrapperCollection &wrappers) {
    declareCentroidResult(wrappers);
    declareCentroidResultKey(wrappers);
    declareCentroidTransform(wrappers);
    declareCentroidChecker(wrappers);
    declareUncertaintyEnum(wrappers);
}
 
}  // namespace base
}  // namespace meas
}  // namespace lsst