LSSTApplications  20.0.0
LSSTDataManagementBasePackage
priors.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"
33 
34 namespace py = pybind11;
35 using namespace pybind11::literals;
36 
37 namespace lsst {
38 namespace meas {
39 namespace modelfit {
40 namespace {
41 
42 static void declarePrior(py::module &mod) {
43  using PyPrior = py::class_<Prior, std::shared_ptr<Prior>>;
44  PyPrior cls(mod, "Prior");
45  cls.def("getTag", &Prior::getTag);
46  cls.def("evaluate", &Prior::evaluate, "nonlinear"_a, "amplitudes"_a);
47  cls.def("evaluateDerivatives", &Prior::evaluateDerivatives, "nonlinear"_a, "amplitudes"_a,
48  "nonlinearGradient"_a, "amplitudeGradient"_a, "nonlinearHessian"_a, "amplitudeHessian"_a,
49  "crossHessian"_a);
50  cls.def("marginalize", &Prior::marginalize, "gradient"_a, "hessian"_a, "nonlinear"_a);
51  cls.def("maximize", &Prior::maximize, "gradient"_a, "hessian"_a, "nonlinear"_a, "amplitudes"_a);
52  cls.def("drawAmplitudes", &Prior::drawAmplitudes, "gradient"_a, "hessian"_a, "nonlinear"_a, "rng"_a,
53  "amplitudes"_a, "weights"_a, "multiplyWeights"_a = false);
54 }
55 
56 static void declareMixturePrior(py::module &mod) {
57  using Class = MixturePrior;
58  using PyClass = py::class_<Class, std::shared_ptr<Class>, Prior>;
59  PyClass cls(mod, "MixturePrior");
60  cls.def(py::init<std::shared_ptr<Mixture>, std::string const &>(), "mixture"_a, "tag"_a = "");
61  cls.def_static("getUpdateRestriction", &Class::getUpdateRestriction,
62  py::return_value_policy::reference); // returned object has static duration
63  cls.def("getMixture", &Class::getMixture);
64  // virtual methods already wrapped by Prior base class
65 }
66 
67 static void declareSemiEmpiricalPrior(py::module &mod) {
68  using Class = SemiEmpiricalPrior;
69  using Control = SemiEmpiricalPriorControl;
70  using PyControl = py::class_<Control, std::shared_ptr<Control>>;
71  using PyClass = py::class_<Class, std::shared_ptr<Class>, Prior>;
72 
73  PyControl clsControl(mod, "SemiEmpiricalPriorControl");
74  clsControl.def(py::init<>());
75  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, ellipticitySigma);
76  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, ellipticityCore);
77  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusMinOuter);
78  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusMinInner);
79  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusMu);
80  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusSigma);
81  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusNu);
82  clsControl.def("validate", &Control::validate);
83 
84  PyClass cls(mod, "SemiEmpiricalPrior");
85  cls.def(py::init<Control>(), "ctrl"_a);
86  cls.attr("Control") = clsControl;
87  // virtual methods already wrapped by Prior base class
88 }
89 
90 static void declareSoftenedLinearPrior(py::module &mod) {
91  using Class = SoftenedLinearPrior;
92  using Control = SoftenedLinearPriorControl;
93  using PyControl = py::class_<Control, std::shared_ptr<Control>>;
94  using PyClass = py::class_<Class, std::shared_ptr<Class>, Prior>;
95 
96  PyControl clsControl(mod, "SoftenedLinearPriorControl");
97  clsControl.def(py::init<>());
98  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, ellipticityMaxOuter);
99  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, ellipticityMaxInner);
100  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusMinOuter);
101  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusMinInner);
102  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusMaxOuter);
103  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusMaxInner);
104  LSST_DECLARE_CONTROL_FIELD(clsControl, Control, logRadiusMinMaxRatio);
105 
106  PyClass cls(mod, "SoftenedLinearPrior");
107  cls.def(py::init<Control>(), "ctrl"_a);
108  cls.def("getControl", &Class::getControl, py::return_value_policy::copy);
109  cls.attr("Control") = clsControl;
110  // virtual methods already wrapped by Prior base class
111 }
112 
113 PYBIND11_MODULE(priors, mod) {
114  py::module::import("lsst.meas.modelfit.mixture");
115 
116  declarePrior(mod);
117  declareMixturePrior(mod);
118  declareSemiEmpiricalPrior(mod);
119  declareSoftenedLinearPrior(mod);
120 }
121 
122 }
123 }
124 }
125 } // namespace lsst::meas::modelfit::anonymous
Prior.h
SemiEmpiricalPrior.h
std::string
STL class.
std::shared_ptr
STL class.
SoftenedLinearPrior.h
MixturePrior.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
PyClass
py::class_< ProductBoundedField, std::shared_ptr< ProductBoundedField >, BoundedField > PyClass
Definition: productBoundedField.cc:32
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
LSST_DECLARE_CONTROL_FIELD
#define LSST_DECLARE_CONTROL_FIELD(WRAPPER, CLASS, NAME)
Macro used to wrap fields declared by LSST_CONTROL_FIELD using Pybind11.
Definition: python.h:50
pybind11
Definition: _GenericMap.cc:40
lsst::utils.tests.init
def init()
Definition: tests.py:58
lsst::ip::diffim.Control
Control
Definition: __init__.py:49
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