photometryModels.cc

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * This file is part of jointcal.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * 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 GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#include "pybind11/pybind11.h"
#include "pybind11/eigen.h"
#include "pybind11/stl.h"
#include "ndarray/pybind11.h"
#include "ndarray/eigen.h"
#include "Eigen/Core"

#include "lsst/utils/python.h"

#include "lsst/jointcal/CcdImage.h"
#include "lsst/jointcal/PhotometryModel.h"
#include "lsst/jointcal/Point.h"
#include "lsst/jointcal/SimplePhotometryModel.h"
#include "lsst/jointcal/ConstrainedPhotometryModel.h"

namespace py = pybind11;
using namespace pybind11::literals;

namespace lsst {
namespace jointcal {
namespace {

void declarePhotometryModel(py::module &mod) {
    py::class_<PhotometryModel, std::shared_ptr<PhotometryModel>> cls(mod, "PhotometryModel");

    cls.def("assignIndices", &PhotometryModel::assignIndices);
    cls.def("freezeErrorTransform", &PhotometryModel::freezeErrorTransform);

    cls.def("offsetParams", &PhotometryModel::offsetParams);
    cls.def("offsetFittedStar", &PhotometryModel::offsetFittedStar);

    cls.def("transform", &PhotometryModel::transform);
    cls.def("transformError", &PhotometryModel::transformError);
    cls.def("computeResidual", &PhotometryModel::computeResidual);

    cls.def("getRefError", &PhotometryModel::getRefError);
    cls.def("computeRefResidual", &PhotometryModel::computeRefResidual);

    cls.def("checkPositiveOnBBox", &PhotometryModel::checkPositiveOnBBox);
    cls.def("validate", &PhotometryModel::validate);

    cls.def("getMappingIndices", &PhotometryModel::getMappingIndices);
    cls.def("computeParameterDerivatives",
            [](PhotometryModel const &self, MeasuredStar const &star, CcdImage const &ccdImage) {
                Eigen::VectorXd derivatives(self.getNpar(ccdImage));
                self.computeParameterDerivatives(star, ccdImage, derivatives);
                return derivatives;
            });

    cls.def("getNpar", &PhotometryModel::getNpar);
    cls.def("toPhotoCalib", &PhotometryModel::toPhotoCalib);
    cls.def("getMapping", &PhotometryModel::getMapping, py::return_value_policy::reference_internal);
    cls.def("getTotalParameters", &PhotometryModel::getTotalParameters);
    utils::python::addOutputOp(cls, "__str__");
}

void declareSimplePhotometryModel(py::module &mod) {
    py::class_<SimplePhotometryModel, std::shared_ptr<SimplePhotometryModel>, PhotometryModel> cls(
            mod, "SimplePhotometryModel");
}

void declareSimpleFluxModel(py::module &mod) {
    py::class_<SimpleFluxModel, std::shared_ptr<SimpleFluxModel>, SimplePhotometryModel, PhotometryModel> cls(
            mod, "SimpleFluxModel");
    cls.def(py::init<CcdImageList const &, double>(), "ccdImageList"_a, "errorPedestal"_a = 0);
}

void declareSimpleMagnitudeModel(py::module &mod) {
    py::class_<SimpleMagnitudeModel, std::shared_ptr<SimpleMagnitudeModel>, SimplePhotometryModel,
               PhotometryModel>
            cls(mod, "SimpleMagnitudeModel");
    cls.def(py::init<CcdImageList const &, double>(), "ccdImageList"_a, "errorPedestal"_a = 0);
}

void declareConstrainedPhotometryModel(py::module &mod) {
    py::class_<ConstrainedPhotometryModel, std::shared_ptr<ConstrainedPhotometryModel>, PhotometryModel> cls(
            mod, "ConstrainedPhotometryModel");
}

void declareConstrainedFluxModel(py::module &mod) {
    py::class_<ConstrainedFluxModel, std::shared_ptr<ConstrainedFluxModel>, PhotometryModel> cls(
            mod, "ConstrainedFluxModel");
    cls.def(py::init<CcdImageList const &, lsst::geom::Box2D const &, int, double>(), "CcdImageList"_a,
            "bbox"_a, "visitOrder"_a = 7, "errorPedestal"_a = 0);
}

void declareConstrainedMagnitudeModel(py::module &mod) {
    py::class_<ConstrainedMagnitudeModel, std::shared_ptr<ConstrainedMagnitudeModel>, PhotometryModel> cls(
            mod, "ConstrainedMagnitudeModel");
    cls.def(py::init<CcdImageList const &, lsst::geom::Box2D const &, int, double>(), "CcdImageList"_a,
            "bbox"_a, "visitOrder"_a = 7, "errorPedestal"_a = 0);
}

PYBIND11_MODULE(photometryModels, mod) {
    py::module::import("lsst.jointcal.ccdImage");
    py::module::import("lsst.jointcal.photometryTransform");
    py::module::import("lsst.jointcal.star");
    declarePhotometryModel(mod);
    declareSimplePhotometryModel(mod);
    declareSimpleFluxModel(mod);
    declareSimpleMagnitudeModel(mod);
    declareConstrainedPhotometryModel(mod);
    declareConstrainedFluxModel(mod);
    declareConstrainedMagnitudeModel(mod);
}
}  // namespace
}  // namespace jointcal
}  // namespace lsst