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
_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 
27 #include "lsst/afw/image/Image.h"
30 
31 namespace py = pybind11;
32 
33 using namespace py::literals;
34 
35 namespace lsst {
36 namespace afw {
37 namespace math {
38 
39 namespace {
40 template <typename ImageT>
41 void declareMakeBackground(lsst::utils::python::WrapperCollection &wrappers) {
42  wrappers.wrap([](auto &mod) { mod.def("makeBackground", makeBackground<ImageT>, "img"_a, "bgCtrl"_a); });
43 }
44 
45 template <typename PixelT, typename PyClass>
46 void 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(),
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 
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 }
163  // FIXME: review when lsst.afw.image is converted to python wrappers
164  wrappers.addInheritanceDependency("lsst.afw.image.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:58
A virtual base class to evaluate image background levels.
Definition: Background.h:235
An integer coordinate rectangle.
Definition: Box.h:55
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition: python.h:242
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition: python.h:448
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition: python.h:391
void addInheritanceDependency(std::string const &name)
Indicate an external module that provides a base class for a subsequent addType call.
Definition: python.h:343
void wrap(WrapperCallback function)
Add a set of wrappers without defining a class.
Definition: python.h:369
void wrapBackground(lsst::utils::python::WrapperCollection &wrappers)
Definition: _background.cc:162
void declareBackground(lsst::utils::python::WrapperCollection &wrappers)
Definition: _background.cc:73
UndersampleStyle stringToUndersampleStyle(std::string const &style)
Conversion function to switch a string to an UndersampleStyle.
Definition: Background.cc:117
py::class_< PixelAreaBoundedField, std::shared_ptr< PixelAreaBoundedField >, BoundedField > PyClass
A base class for image defects.