LSSTApplications  20.0.0
LSSTDataManagementBasePackage
photometryModels.cc
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of jointcal.
4  *
5  * Developed for the LSST Data Management System.
6  * This product includes software developed by the LSST Project
7  * (https://www.lsst.org).
8  * See the COPYRIGHT file at the top-level directory of this distribution
9  * for details of code ownership.
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  */
24 
25 #include "pybind11/pybind11.h"
26 #include "pybind11/eigen.h"
27 #include "pybind11/stl.h"
28 #include "ndarray/pybind11.h"
29 #include "ndarray/eigen.h"
30 #include "Eigen/Core"
31 
32 #include "lsst/utils/python.h"
33 
34 #include "lsst/jointcal/CcdImage.h"
36 #include "lsst/jointcal/Point.h"
39 
40 namespace py = pybind11;
41 using namespace pybind11::literals;
42 
43 namespace lsst {
44 namespace jointcal {
45 namespace {
46 
47 void declarePhotometryModel(py::module &mod) {
48  py::class_<PhotometryModel, std::shared_ptr<PhotometryModel>> cls(mod, "PhotometryModel");
49 
50  cls.def("assignIndices", &PhotometryModel::assignIndices);
51  cls.def("freezeErrorTransform", &PhotometryModel::freezeErrorTransform);
52 
53  cls.def("offsetParams", &PhotometryModel::offsetParams);
54  cls.def("offsetFittedStar", &PhotometryModel::offsetFittedStar);
55 
56  cls.def("transform", &PhotometryModel::transform);
57  cls.def("transformError", &PhotometryModel::transformError);
58  cls.def("computeResidual", &PhotometryModel::computeResidual);
59 
60  cls.def("getRefError", &PhotometryModel::getRefError);
61  cls.def("computeRefResidual", &PhotometryModel::computeRefResidual);
62 
63  cls.def("checkPositiveOnBBox", &PhotometryModel::checkPositiveOnBBox);
64  cls.def("validate", &PhotometryModel::validate);
65 
66  cls.def("getMappingIndices", &PhotometryModel::getMappingIndices);
67  cls.def("computeParameterDerivatives",
68  [](PhotometryModel const &self, MeasuredStar const &star, CcdImage const &ccdImage) {
69  Eigen::VectorXd derivatives(self.getNpar(ccdImage));
70  self.computeParameterDerivatives(star, ccdImage, derivatives);
71  return derivatives;
72  });
73 
74  cls.def("getNpar", &PhotometryModel::getNpar);
75  cls.def("toPhotoCalib", &PhotometryModel::toPhotoCalib);
76  cls.def("getMapping", &PhotometryModel::getMapping, py::return_value_policy::reference_internal);
77  cls.def("getTotalParameters", &PhotometryModel::getTotalParameters);
78 
79  utils::python::addOutputOp(cls, "__repr__");
80  cls.def("__str__", [](PhotometryModel const &self) { return "PhotometryModel"; });
81 }
82 
83 void declareSimplePhotometryModel(py::module &mod) {
84  py::class_<SimplePhotometryModel, std::shared_ptr<SimplePhotometryModel>, PhotometryModel> cls(
85  mod, "SimplePhotometryModel");
86  cls.def("__str__", [](SimplePhotometryModel const &self) { return "SimplePhotometryModel"; });
87 }
88 
89 void declareSimpleFluxModel(py::module &mod) {
90  py::class_<SimpleFluxModel, std::shared_ptr<SimpleFluxModel>, SimplePhotometryModel, PhotometryModel> cls(
91  mod, "SimpleFluxModel");
92  cls.def(py::init<CcdImageList const &, double>(), "ccdImageList"_a, "errorPedestal"_a = 0);
93 
94  cls.def("__str__", [](SimpleFluxModel const &self) { return "SimpleFluxModel"; });
95 }
96 
97 void declareSimpleMagnitudeModel(py::module &mod) {
98  py::class_<SimpleMagnitudeModel, std::shared_ptr<SimpleMagnitudeModel>, SimplePhotometryModel,
99  PhotometryModel>
100  cls(mod, "SimpleMagnitudeModel");
101  cls.def(py::init<CcdImageList const &, double>(), "ccdImageList"_a, "errorPedestal"_a = 0);
102 
103  cls.def("__str__", [](SimpleMagnitudeModel const &self) { return "SimpleMagnitudeModel"; });
104 }
105 
106 void declareConstrainedPhotometryModel(py::module &mod) {
107  py::class_<ConstrainedPhotometryModel, std::shared_ptr<ConstrainedPhotometryModel>, PhotometryModel> cls(
108  mod, "ConstrainedPhotometryModel");
109  cls.def("__str__", [](ConstrainedPhotometryModel const &self) { return "ConstrainedPhotometryModel"; });
110 }
111 
112 void declareConstrainedFluxModel(py::module &mod) {
113  py::class_<ConstrainedFluxModel, std::shared_ptr<ConstrainedFluxModel>, PhotometryModel> cls(
114  mod, "ConstrainedFluxModel");
115  cls.def(py::init<CcdImageList const &, lsst::geom::Box2D const &, int, double>(), "CcdImageList"_a,
116  "bbox"_a, "visitOrder"_a = 7, "errorPedestal"_a = 0);
117  cls.def("__str__", [](ConstrainedFluxModel const &self) { return "ConstrainedFluxModel"; });
118 }
119 
120 void declareConstrainedMagnitudeModel(py::module &mod) {
121  py::class_<ConstrainedMagnitudeModel, std::shared_ptr<ConstrainedMagnitudeModel>, PhotometryModel> cls(
122  mod, "ConstrainedMagnitudeModel");
123  cls.def(py::init<CcdImageList const &, lsst::geom::Box2D const &, int, double>(), "CcdImageList"_a,
124  "bbox"_a, "visitOrder"_a = 7, "errorPedestal"_a = 0);
125  cls.def("__str__", [](ConstrainedMagnitudeModel const &self) { return "ConstrainedMagnitudeModel"; });
126 }
127 
128 PYBIND11_MODULE(photometryModels, mod) {
129  py::module::import("lsst.jointcal.ccdImage");
130  py::module::import("lsst.jointcal.photometryTransform");
131  py::module::import("lsst.jointcal.star");
132  declarePhotometryModel(mod);
133  declareSimplePhotometryModel(mod);
134  declareSimpleFluxModel(mod);
135  declareSimpleMagnitudeModel(mod);
136  declareConstrainedPhotometryModel(mod);
137  declareConstrainedFluxModel(mod);
138  declareConstrainedMagnitudeModel(mod);
139 }
140 } // namespace
141 } // namespace jointcal
142 } // namespace lsst
lsst::utils::python::addOutputOp
void addOutputOp(PyClass &cls, std::string const &method)
Add __str__ or __repr__ method implemented by operator<<.
Definition: python.h:87
SimplePhotometryModel.h
CcdImage.h
ConstrainedPhotometryModel.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
Point.h
lsst::jointcal
Definition: Associations.h:49
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
PhotometryModel.h
transform
table::Key< int > transform
Definition: TransformMap.cc:299
pybind11
Definition: _GenericMap.cc:40
lsst::meas::modelfit.psf.psfContinued.module
module
Definition: psfContinued.py:42
lsst::afw::cameraGeom::PYBIND11_MODULE
PYBIND11_MODULE(camera, mod)
Definition: camera.cc:133
pex.config.wrap.validate
validate
Definition: wrap.py:295