LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
_background.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2008-2016 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 <lsst/utils/python.h>
25#include <pybind11/stl.h>
26
30
31namespace py = pybind11;
32
33using namespace py::literals;
34
35namespace lsst {
36namespace afw {
37namespace math {
38
39namespace {
40template <typename ImageT>
41void declareMakeBackground(lsst::utils::python::WrapperCollection &wrappers) {
42 wrappers.wrap([](auto &mod) { mod.def("makeBackground", makeBackground<ImageT>, "img"_a, "bgCtrl"_a); });
43}
44
45template <typename PixelT, typename PyClass>
46void declareGetImage(PyClass &cls, std::string const &suffix) {
47 cls.def(("getImage" + suffix).c_str(),
48 (std::shared_ptr<lsst::afw::image::Image<PixelT>>(Background::*)(Interpolate::Style const,
49 UndersampleStyle const) const) &
50 Background::getImage<PixelT>,
51 "interpStyle"_a, "undersampleStyle"_a = THROW_EXCEPTION);
52 cls.def(("getImage" + suffix).c_str(),
53 (std::shared_ptr<lsst::afw::image::Image<PixelT>>(Background::*)(std::string const &,
54 std::string const &) const) &
55 Background::getImage<PixelT>,
56 "interpStyle"_a, "undersampleStyle"_a = "THROW_EXCEPTION");
57 cls.def(("getImage" + suffix).c_str(),
59 lsst::geom::Box2I const &, Interpolate::Style const, UndersampleStyle const) const) &
60 Background::getImage<PixelT>,
61 "bbox"_a, "interpStyle"_a, "undersampleStyle"_a = THROW_EXCEPTION);
62 cls.def(("getImage" + suffix).c_str(),
64 lsst::geom::Box2I const &, std::string const &, std::string const &) const) &
65 Background::getImage<PixelT>,
66 "bbox"_a, "interpStyle"_a, "undersampleStyle"_a = "THROW_EXCEPTION");
67 cls.def(("getImage" + suffix).c_str(),
68 (std::shared_ptr<lsst::afw::image::Image<PixelT>>(Background::*)() const) &
69 Background::getImage<PixelT>);
70}
71} // namespace
72
73void declareBackground(lsst::utils::python::WrapperCollection &wrappers) {
74 /* Member types and enums */
75 wrappers.wrapType(py::enum_<UndersampleStyle>(wrappers.module, "UndersampleStyle"),
76 [](auto &mod, auto &enm) {
77 enm.value("THROW_EXCEPTION", UndersampleStyle::THROW_EXCEPTION);
78 enm.value("REDUCE_INTERP_ORDER", UndersampleStyle::REDUCE_INTERP_ORDER);
79 enm.value("INCREASE_NXNYSAMPLE", UndersampleStyle::INCREASE_NXNYSAMPLE);
80 enm.export_values();
81 });
82
83 using PyBackgroundControl = py::class_<BackgroundControl, std::shared_ptr<BackgroundControl>>;
84 wrappers.wrapType(PyBackgroundControl(wrappers.module, "BackgroundControl"), [](auto &mod, auto &cls) {
85 /* Constructors */
86 cls.def(py::init<int const, int const, StatisticsControl const, Property const,
87 ApproximateControl const>(),
88 "nxSample"_a, "nySample"_a, "sctrl"_a = StatisticsControl(), "prop"_a = MEANCLIP,
89 "actrl"_a = ApproximateControl(ApproximateControl::UNKNOWN, 1));
90 cls.def(py::init<int const, int const, StatisticsControl const, std::string const &,
91 ApproximateControl const>(),
92 "nxSample"_a, "nySample"_a, "sctrl"_a, "prop"_a,
93 "actrl"_a = ApproximateControl(ApproximateControl::UNKNOWN, 1));
94 cls.def(py::init<Interpolate::Style const, int const, int const, UndersampleStyle const,
95 StatisticsControl const, Property const, ApproximateControl const>(),
96 "style"_a, "nxSample"_a = 10, "nySample"_a = 10, "undersampleStyle"_a = THROW_EXCEPTION,
97 "sctrl"_a = StatisticsControl(), "prop"_a = MEANCLIP,
98 "actrl"_a = ApproximateControl(ApproximateControl::UNKNOWN, 1));
99 cls.def(py::init<std::string const &, int const, int const, std::string const &,
100 StatisticsControl const, std::string const &, ApproximateControl const>(),
101 "style"_a, "nxSample"_a = 10, "nySample"_a = 10, "undersampleStyle"_a = "THROW_EXCEPTION",
102 "sctrl"_a = StatisticsControl(), "prop"_a = "MEANCLIP",
103 "actrl"_a = ApproximateControl(ApproximateControl::UNKNOWN, 1));
104
105 /* Members */
106 cls.def("setNxSample", &BackgroundControl::setNxSample);
107 cls.def("setNySample", &BackgroundControl::setNySample);
108 cls.def("setInterpStyle",
109 (void (BackgroundControl::*)(Interpolate::Style const)) & BackgroundControl::setInterpStyle);
110 cls.def("setInterpStyle",
111 (void (BackgroundControl::*)(std::string const &)) & BackgroundControl::setInterpStyle);
112 cls.def("setUndersampleStyle", (void (BackgroundControl::*)(UndersampleStyle const)) &
113 BackgroundControl::setUndersampleStyle);
114 cls.def("setUndersampleStyle",
115 (void (BackgroundControl::*)(std::string const &)) & BackgroundControl::setUndersampleStyle);
116 cls.def("getNxSample", &BackgroundControl::getNxSample);
117 cls.def("getNySample", &BackgroundControl::getNySample);
118 cls.def("getInterpStyle", &BackgroundControl::getInterpStyle);
119 cls.def("getUndersampleStyle", &BackgroundControl::getUndersampleStyle);
120 cls.def("getStatisticsControl", (std::shared_ptr<StatisticsControl>(BackgroundControl::*)()) &
121 BackgroundControl::getStatisticsControl);
122 cls.def("getStatisticsProperty", &BackgroundControl::getStatisticsProperty);
123 cls.def("setStatisticsProperty",
124 (void (BackgroundControl::*)(Property)) & BackgroundControl::setStatisticsProperty);
125 cls.def("setStatisticsProperty",
126 (void (BackgroundControl::*)(std::string)) & BackgroundControl::setStatisticsProperty);
127 cls.def("setApproximateControl", &BackgroundControl::setApproximateControl);
128 cls.def("getApproximateControl", (std::shared_ptr<ApproximateControl>(BackgroundControl::*)()) &
129 BackgroundControl::getApproximateControl);
130 });
131 using PyBackground = py::class_<Background, std::shared_ptr<Background>>;
132 wrappers.wrapType(PyBackground(wrappers.module, "Background"), [](auto &mod, auto &cls) {
133 /* Members */
134 declareGetImage<float>(cls, "F");
135
136 cls.def("getAsUsedInterpStyle", &Background::getAsUsedInterpStyle);
137 cls.def("getAsUsedUndersampleStyle", &Background::getAsUsedUndersampleStyle);
138 cls.def("getApproximate", &Background::getApproximate, "actrl"_a,
139 "undersampleStyle"_a = THROW_EXCEPTION);
140 cls.def("getBackgroundControl",
141 (std::shared_ptr<BackgroundControl>(Background::*)()) & Background::getBackgroundControl);
142 });
143
144 using PyBackgroundMI = py::class_<BackgroundMI, std::shared_ptr<BackgroundMI>, Background>;
145 wrappers.wrapType(PyBackgroundMI(wrappers.module, "BackgroundMI"), [](auto &mod, auto &cls) {
146 /* Constructors */
147 cls.def(py::init<lsst::geom::Box2I const,
148 image::MaskedImage<typename Background::InternalPixelT> const &>(),
149 "imageDimensions"_a, "statsImage"_a);
150
151 /* Operators */
152 cls.def("__iadd__", &BackgroundMI::operator+=);
153 cls.def("__isub__", &BackgroundMI::operator-=);
154
155 /* Members */
156 cls.def("getStatsImage", &BackgroundMI::getStatsImage);
157 cls.def("getImageBBox", &BackgroundMI::getImageBBox);
158
159 // Yes, really only float
160 });
161}
162void wrapBackground(lsst::utils::python::WrapperCollection &wrappers) {
163 // FIXME: review when lsst.afw.image is converted to python wrappers
164 wrappers.addInheritanceDependency("lsst.afw.image");
165 declareBackground(wrappers);
166 declareMakeBackground<image::Image<float>>(wrappers);
167 declareMakeBackground<image::MaskedImage<float>>(wrappers);
168 wrappers.wrap(
169 [](auto &mod) { mod.def("stringToUndersampleStyle", stringToUndersampleStyle, "style"_a); });
170}
171} // namespace math
172} // namespace afw
173} // namespace lsst
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
A virtual base class to evaluate image background levels.
Definition Background.h:235
py::class_< PixelAreaBoundedField, std::shared_ptr< PixelAreaBoundedField >, BoundedField > PyClass
void wrapBackground(lsst::utils::python::WrapperCollection &wrappers)
void declareBackground(lsst::utils::python::WrapperCollection &wrappers)
UndersampleStyle stringToUndersampleStyle(std::string const &style)
Conversion function to switch a string to an UndersampleStyle.
STL namespace.