LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
cmodel.cc
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2013 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #include "pybind11/pybind11.h"
25 
26 #include "ndarray/pybind11.h"
27 
28 #include "lsst/pex/config/python.h"
30 
31 namespace py = pybind11;
32 using namespace pybind11::literals;
33 
34 namespace lsst {
35 namespace meas {
36 namespace modelfit {
37 namespace {
38 
39 using PyCModelStageControl = py::class_<CModelStageControl, std::shared_ptr<CModelStageControl>>;
40 using PyCModelControl = py::class_<CModelControl, std::shared_ptr<CModelControl>>;
41 using PyCModelStageResult = py::class_<CModelStageResult, std::shared_ptr<CModelStageResult>>;
42 using PyCModelResult = py::class_<CModelResult, std::shared_ptr<CModelResult>>;
43 using PyCModelAlgorithm = py::class_<CModelAlgorithm, std::shared_ptr<CModelAlgorithm>>;
44 
45 static PyCModelStageControl declareCModelStageControl(py::module &mod) {
46  PyCModelStageControl cls(mod, "CModelStageControl");
47  cls.def(py::init<>());
48  cls.def("getProfile", &CModelStageControl::getProfile);
49  cls.def("getModel", &CModelStageControl::getModel);
50  cls.def("getPrior", &CModelStageControl::getPrior);
51  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, profileName);
52  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, priorSource);
53  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, priorName);
54  LSST_DECLARE_NESTED_CONTROL_FIELD(cls, CModelStageControl, linearPriorConfig);
55  LSST_DECLARE_NESTED_CONTROL_FIELD(cls, CModelStageControl, empiricalPriorConfig);
56  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, nComponents);
57  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, maxRadius);
58  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, usePixelWeights);
59  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, weightsMultiplier);
60  LSST_DECLARE_NESTED_CONTROL_FIELD(cls, CModelStageControl, optimizer);
61  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, doRecordHistory);
62  LSST_DECLARE_CONTROL_FIELD(cls, CModelStageControl, doRecordTime);
63  return cls;
64 }
65 
66 static PyCModelControl declareCModelControl(py::module &mod) {
67  PyCModelControl cls(mod, "CModelControl");
68  cls.def(py::init<>());
69  LSST_DECLARE_CONTROL_FIELD(cls, CModelControl, psfName);
70  LSST_DECLARE_NESTED_CONTROL_FIELD(cls, CModelControl, region);
71  LSST_DECLARE_NESTED_CONTROL_FIELD(cls, CModelControl, initial);
72  LSST_DECLARE_NESTED_CONTROL_FIELD(cls, CModelControl, exp);
73  LSST_DECLARE_NESTED_CONTROL_FIELD(cls, CModelControl, dev);
74  LSST_DECLARE_CONTROL_FIELD(cls, CModelControl, minInitialRadius);
75  LSST_DECLARE_CONTROL_FIELD(cls, CModelControl, fallbackInitialMomentsPsfFactor);
76  return cls;
77 }
78 
79 // Custom wrapper for views to std::bitset.
80 template <int N>
81 class BitSetView {
82 public:
83  explicit BitSetView(std::bitset<N> const *target) : _target(target) {}
84 
85  bool operator[](int i) const { return (*_target)[i]; }
86 
87  constexpr std::size_t size() const { return N; }
88 
89  template <typename PyParent>
90  static void declare(PyParent &parent) {
91  py::class_<BitSetView<N>> cls(parent, ("BitSetView" + std::to_string(N)).c_str());
92  cls.def("__getitem__", &BitSetView<N>::operator[]);
93  cls.def("__len__", &BitSetView<N>::size);
94  }
95 
96 private:
97  std::bitset<N> const *_target;
98 };
99 
100 static PyCModelStageResult declareCModelStageResult(py::module &mod) {
101  PyCModelStageResult cls(mod, "CModelStageResult");
102 
103  cls.def(py::init<>());
104 
105  cls.attr("FAILED") = py::cast(int(CModelStageResult::FAILED));
106  cls.attr("TR_SMALL") = py::cast(int(CModelStageResult::TR_SMALL));
107  cls.attr("MAX_ITERATIONS") = py::cast(int(CModelStageResult::MAX_ITERATIONS));
108  cls.attr("NUMERIC_ERROR") = py::cast(int(CModelStageResult::NUMERIC_ERROR));
109  cls.attr("BAD_REFERENCE") = py::cast(int(CModelStageResult::BAD_REFERENCE));
110  cls.attr("NO_FLUX") = py::cast(int(CModelStageResult::NO_FLUX));
111  cls.attr("N_FLAGS") = py::cast(int(CModelStageResult::N_FLAGS));
112 
113  // Data members are intentionally read-only from the Python side;
114  // they should only be set by the C++ algorithm code that uses
115  // this class to communicate its outputs.
116  cls.def_readonly("model", &CModelStageResult::model);
117  cls.def_readonly("prior", &CModelStageResult::prior);
118  cls.def_readonly("objfunc", &CModelStageResult::objfunc);
119  cls.def_readonly("likelihood", &CModelStageResult::likelihood);
120  cls.def_readonly("instFlux", &CModelStageResult::instFlux);
121  cls.def_readonly("instFluxErr", &CModelStageResult::instFluxErr);
122  cls.def_readonly("instFluxInner", &CModelStageResult::instFluxInner);
123  cls.def_readonly("objective", &CModelStageResult::objective);
124  cls.def_readonly("time", &CModelStageResult::time);
125  cls.def_readonly("ellipse", &CModelStageResult::ellipse);
126  cls.def_readonly("nonlinear", &CModelStageResult::nonlinear);
127  cls.def_readonly("amplitudes", &CModelStageResult::amplitudes);
128  cls.def_readonly("fixed", &CModelStageResult::fixed);
129 
130  // Declare wrappers for a view class for the flags attribute
132  // Wrap the flag. attributes
133  cls.def_property_readonly(
134  "flags",
135  [](CModelStageResult const &self) { return BitSetView<CModelStageResult::N_FLAGS>(&self.flags); },
136  py::return_value_policy::reference_internal);
137 
138  return cls;
139 }
140 
141 static PyCModelResult declareCModelResult(py::module &mod) {
142  PyCModelResult cls(mod, "CModelResult");
143 
144  cls.def(py::init<>());
145 
146  cls.attr("FAILED") = py::cast(int(CModelResult::FAILED));
147  cls.attr("REGION_MAX_AREA") = py::cast(int(CModelResult::REGION_MAX_AREA));
148  cls.attr("REGION_MAX_BAD_PIXEL_FRACTION") = py::cast(int(CModelResult::REGION_MAX_BAD_PIXEL_FRACTION));
149  cls.attr("REGION_USED_FOOTPRINT_AREA") = py::cast(int(CModelResult::REGION_USED_FOOTPRINT_AREA));
150  cls.attr("REGION_USED_PSF_AREA") = py::cast(int(CModelResult::REGION_USED_PSF_AREA));
151  cls.attr("REGION_USED_INITIAL_ELLIPSE_MIN") =
152  py::cast(int(CModelResult::REGION_USED_INITIAL_ELLIPSE_MIN));
153  cls.attr("REGION_USED_INITIAL_ELLIPSE_MAX") =
154  py::cast(int(CModelResult::REGION_USED_INITIAL_ELLIPSE_MAX));
155  cls.attr("NO_FLUX") = py::cast(int(CModelResult::NO_FLUX));
156 
157  // Data members are intentionally read-only from the Python side;
158  // they should only be set by the C++ algorithm code that uses
159  // this class to communicate its outputs.
160  cls.def_readonly("instFlux", &CModelResult::instFlux);
161  cls.def_readonly("instFluxErr", &CModelResult::instFluxErr);
162  cls.def_readonly("instFluxInner", &CModelResult::instFluxInner);
163  cls.def_readonly("fracDev", &CModelResult::fracDev);
164  cls.def_readonly("objective", &CModelResult::objective);
165  cls.def_readonly("initial", &CModelResult::initial);
166  cls.def_readonly("exp", &CModelResult::exp);
167  cls.def_readonly("dev", &CModelResult::dev);
168  cls.def_readonly("initialFitRegion", &CModelResult::initialFitRegion);
169  cls.def_readonly("finalFitRegion", &CModelResult::finalFitRegion);
170  cls.def_readonly("fitSysToMeasSys", &CModelResult::fitSysToMeasSys);
171 
172  // Declare wrappers for a view class for the flags attribute
174  // Wrap the flag. attributes
175  cls.def_property_readonly(
176  "flags", [](CModelResult const &self) { return BitSetView<CModelResult::N_FLAGS>(&self.flags); },
177  py::return_value_policy::reference_internal);
178 
179  return cls;
180 }
181 
182 static PyCModelAlgorithm declareCModelAlgorithm(py::module &mod) {
183  PyCModelAlgorithm cls(mod, "CModelAlgorithm");
184  cls.def(py::init<std::string const &, CModelControl const &, afw::table::Schema &>(), "name"_a, "ctrl"_a,
185  "schema"_a);
186  cls.def(py::init<std::string const &, CModelControl const &, afw::table::SchemaMapper &>(), "name"_a,
187  "ctrl"_a, "schemaMapper"_a);
188  cls.def(py::init<CModelControl const &>(), "ctrl"_a);
189  cls.def("getControl", &CModelAlgorithm::getControl);
190  cls.def("apply", &CModelAlgorithm::apply, "exposure"_a, "psf"_a, "center"_a, "moments"_a,
191  "approxFlux"_a = -1, "kronRadius"_a = -1, "footprintArea"_a = -1);
192  cls.def("applyForced", &CModelAlgorithm::applyForced, "exposure"_a, "psf"_a, "center"_a, "reference"_a,
193  "approxFlux"_a = -1);
194  cls.def("measure", (void (CModelAlgorithm::*)(afw::table::SourceRecord &,
195  afw::image::Exposure<Pixel> const &) const) &
197  "measRecord"_a, "exposure"_a);
198  cls.def("measure",
199  (void (CModelAlgorithm::*)(afw::table::SourceRecord &, afw::image::Exposure<Pixel> const &,
200  afw::table::SourceRecord const &) const) &
202  "measRecord"_a, "exposure"_a, "refRecord"_a);
203  cls.def("fail", &CModelAlgorithm::fail, "measRecord"_a, "error"_a);
204  cls.def("writeResultToRecord", &CModelAlgorithm::writeResultToRecord, "result"_a, "record"_a);
205  return cls;
206 }
207 
208 PYBIND11_MODULE(cmodel, mod) {
209  py::module::import("lsst.afw.geom.ellipses");
210  py::module::import("lsst.afw.detection");
211  py::module::import("lsst.meas.modelfit.model");
212  py::module::import("lsst.meas.modelfit.priors");
213  py::module::import("lsst.meas.modelfit.optimizer");
214  py::module::import("lsst.meas.modelfit.pixelFitRegion");
215  py::module::import("lsst.meas.modelfit.unitTransformedLikelihood");
216 
217  declareCModelStageControl(mod);
218  auto clsControl = declareCModelControl(mod);
219  declareCModelStageResult(mod);
220  auto clsResult = declareCModelResult(mod);
221  auto clsAlgorithm = declareCModelAlgorithm(mod);
222  clsAlgorithm.attr("Control") = clsControl;
223  clsAlgorithm.attr("Result") = clsResult;
224 }
225 
226 }
227 }
228 }
229 } // namespace lsst::meas::modelfit::anonymous
Key< Flag > const & target
table::Key< table::Array< double > > amplitudes
PYBIND11_MODULE(_cameraGeom, mod)
Definition: _cameraGeom.cc:38
def measure(mi, x, y, size, statistic, stats)
Definition: fringe.py:512
def declare(module, exception_name, base, wrapped_class)
Definition: wrappers.py:153
A base class for image defects.
#define LSST_DECLARE_CONTROL_FIELD(WRAPPER, CLASS, NAME)
Macro used to wrap fields declared by LSST_CONTROL_FIELD using Pybind11.
Definition: python.h:50
#define LSST_DECLARE_NESTED_CONTROL_FIELD(WRAPPER, CLASS, NAME)
Macro used to wrap fields declared by LSST_NESTED_CONTROL_FIELD using Pybind11.
Definition: python.h:72
T to_string(T... args)