LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
localBackground.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2018 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #include "pybind11/pybind11.h"
24 #include "pybind11/stl.h"
25 
26 #include <memory>
27 
28 #include "lsst/pex/config/python.h"
29 #include "lsst/meas/base/python.h"
30 
33 
34 namespace py = pybind11;
35 using namespace pybind11::literals;
36 
37 namespace lsst {
38 namespace meas {
39 namespace base {
40 
41 namespace {
42 
43 using PyAlgorithm =
44  py::class_<LocalBackgroundAlgorithm, std::shared_ptr<LocalBackgroundAlgorithm>, SimpleAlgorithm>;
45 using PyControl = py::class_<LocalBackgroundControl>;
46 using PyTransform =
47  py::class_<LocalBackgroundTransform, std::shared_ptr<LocalBackgroundTransform>, BaseTransform>;
48 
49 PyControl declareControl(py::module &mod) {
50  PyControl cls(mod, "LocalBackgroundControl");
51 
52  LSST_DECLARE_CONTROL_FIELD(cls, LocalBackgroundControl, badMaskPlanes);
53  LSST_DECLARE_CONTROL_FIELD(cls, LocalBackgroundControl, annulusInner);
54  LSST_DECLARE_CONTROL_FIELD(cls, LocalBackgroundControl, annulusOuter);
55  LSST_DECLARE_CONTROL_FIELD(cls, LocalBackgroundControl, bgRej);
56  LSST_DECLARE_CONTROL_FIELD(cls, LocalBackgroundControl, bgIter);
57 
58  cls.def(py::init<>());
59 
60  return cls;
61 }
62 
63 PyAlgorithm declareAlgorithm(py::module &mod) {
64  PyAlgorithm cls(mod, "LocalBackgroundAlgorithm");
65 
66  cls.attr("FAILURE") = py::cast(LocalBackgroundAlgorithm::FAILURE);
67  cls.attr("NO_GOOD_PIXELS") = py::cast(LocalBackgroundAlgorithm::NO_GOOD_PIXELS);
68 
69  cls.def(py::init<LocalBackgroundAlgorithm::Control const &, std::string const &, afw::table::Schema &>(),
70  "ctrl"_a, "name"_a, "schema"_a);
71 
72  cls.def(py::init<LocalBackgroundAlgorithm::Control const &, std::string const &, afw::table::Schema &,
73  std::string const &>(),
74  "ctrl"_a, "name"_a, "schema"_a, "logName"_a);
75  return cls;
76 }
77 
78 PyTransform declareTransform(py::module &mod) {
79  PyTransform cls(mod, "LocalBackgroundTransform");
80 
81  cls.def(py::init<LocalBackgroundTransform::Control const &, std::string const &,
82  afw::table::SchemaMapper &>(),
83  "ctrl"_a, "name"_a, "mapper"_a);
84 
85  return cls;
86 }
87 
88 } // namespace
89 
90 PYBIND11_MODULE(localBackground, mod) {
91  py::module::import("lsst.afw.table");
92  py::module::import("lsst.meas.base.algorithm");
93  py::module::import("lsst.meas.base.flagHandler");
94  py::module::import("lsst.meas.base.fluxUtilities");
95  py::module::import("lsst.meas.base.transform");
96 
97  auto clsControl = declareControl(mod);
98  auto clsAlgorithm = declareAlgorithm(mod);
99  auto clsTransform = declareTransform(mod);
100 
101  clsAlgorithm.attr("Control") = clsControl;
102  clsTransform.attr("Control") = clsControl;
103 
104  python::declareAlgorithm<LocalBackgroundAlgorithm, LocalBackgroundControl, LocalBackgroundTransform>(
105  clsAlgorithm, clsControl, clsTransform);
106 }
107 
108 } // namespace base
109 } // namespace meas
110 } // namespace lsst
void declareAlgorithm(PyAlg &clsAlgorithm)
Wrap the implicit API used by meas_base's algorithms.
Definition: python.h:87
PYBIND11_MODULE(localBackground, mod)
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