LSSTApplications  20.0.0
LSSTDataManagementBasePackage
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 
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
std::string
STL class.
base
Definition: __init__.py:1
lsst::meas::base.plugins.BaseTransform
BaseTransform
Definition: plugins.py:98
FluxUtilities.h
LocalBackground.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
lsst::meas::base::python::declareAlgorithm
void declareAlgorithm(PyAlg &clsAlgorithm)
Wrap the implicit API used by meas_base's algorithms.
Definition: python.h:87
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
lsst::meas::base::PYBIND11_MODULE
PYBIND11_MODULE(localBackground, mod)
Definition: localBackground.cc:90
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
python.h
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