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
_statistics.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 
28 
29 namespace py = pybind11;
30 using namespace pybind11::literals;
31 
32 namespace lsst {
33 namespace afw {
34 namespace math {
35 
36 template <typename Pixel>
38  wrappers.wrap([](auto &mod) {
39  mod.def("makeStatistics",
40  (Statistics(*)(image::Image<Pixel> const &, image::Mask<image::MaskPixel> const &, int const,
41  StatisticsControl const &))makeStatistics<Pixel>,
42  "img"_a, "msk"_a, "flags"_a, "sctrl"_a = StatisticsControl());
43  mod.def("makeStatistics",
44  (Statistics(*)(image::MaskedImage<Pixel> const &, int const,
45  StatisticsControl const &))makeStatistics<Pixel>,
46  "mimg"_a, "flags"_a, "sctrl"_a = StatisticsControl());
47  mod.def("makeStatistics",
49  int const, StatisticsControl const &))makeStatistics<Pixel>,
50  "mimg"_a, "weights"_a, "flags"_a, "sctrl"_a = StatisticsControl());
51  mod.def("makeStatistics",
52  (Statistics(*)(image::Mask<image::MaskPixel> const &, int const, StatisticsControl const &))
53  makeStatistics, // this is not a template, just a regular overload
54  "msk"_a, "flags"_a, "sctrl"_a = StatisticsControl());
55  mod.def("makeStatistics",
56  (Statistics(*)(image::Image<Pixel> const &, int const,
57  StatisticsControl const &))makeStatistics<Pixel>,
58  "img"_a, "flags"_a, "sctrl"_a = StatisticsControl());
59  });
60 }
61 
62 template <typename Pixel>
64  wrappers.wrap([](auto &mod) {
65  mod.def("makeStatistics",
66  (Statistics(*)(std::vector<Pixel> const &, int const,
67  StatisticsControl const &))makeStatistics<Pixel>,
68  "v"_a, "flags"_a, "sctrl"_a = StatisticsControl());
69  mod.def("makeStatistics",
70  (Statistics(*)(std::vector<Pixel> const &, std::vector<WeightPixel> const &, int const,
71  StatisticsControl const &))makeStatistics<Pixel>,
72  "v"_a, "vweights"_a, "flags"_a, "sctrl"_a = StatisticsControl());
73  });
74 }
75 
77  /* Module level */
78  wrappers.wrapType(py::enum_<Property>(wrappers.module, "Property", py::arithmetic()),
79  [](auto &mod, auto &enm) {
80  enm.value("NOTHING", Property::NOTHING);
81  enm.value("ERRORS", Property::ERRORS);
82  enm.value("NPOINT", Property::NPOINT);
83  enm.value("MEAN", Property::MEAN);
84  enm.value("STDEV", Property::STDEV);
85  enm.value("VARIANCE", Property::VARIANCE);
86  enm.value("MEDIAN", Property::MEDIAN);
87  enm.value("IQRANGE", Property::IQRANGE);
88  enm.value("MEANCLIP", Property::MEANCLIP);
89  enm.value("STDEVCLIP", Property::STDEVCLIP);
90  enm.value("VARIANCECLIP", Property::VARIANCECLIP);
91  enm.value("MIN", Property::MIN);
92  enm.value("MAX", Property::MAX);
93  enm.value("SUM", Property::SUM);
94  enm.value("MEANSQUARE", Property::MEANSQUARE);
95  enm.value("ORMASK", Property::ORMASK);
96  enm.value("NCLIPPED", Property::NCLIPPED);
97  enm.value("NMASKED", Property::NMASKED);
98  enm.export_values();
99  });
100 
101  wrappers.wrap([](auto &mod) { mod.def("stringToStatisticsProperty", stringToStatisticsProperty); });
102 
103  using PyClass = py::class_<StatisticsControl, std::shared_ptr<StatisticsControl>>;
104  auto control = wrappers.wrapType(PyClass(wrappers.module, "StatisticsControl"), [](auto &mod, auto &cls) {
105  cls.def(py::init<double, int, lsst::afw::image::MaskPixel, bool,
106  typename StatisticsControl::WeightsBoolean>(),
107  "numSigmaClip"_a = 3.0, "numIter"_a = 3, "andMask"_a = 0x0, "isNanSafe"_a = true,
108  "useWeights"_a = StatisticsControl::WEIGHTS_NONE);
109 
110  cls.def("getMaskPropagationThreshold", &StatisticsControl::getMaskPropagationThreshold);
111  cls.def("setMaskPropagationThreshold", &StatisticsControl::setMaskPropagationThreshold);
112  cls.def("getNumSigmaClip", &StatisticsControl::getNumSigmaClip);
113  cls.def("getNumIter", &StatisticsControl::getNumIter);
114  cls.def("getAndMask", &StatisticsControl::getAndMask);
115  cls.def("getNoGoodPixelsMask", &StatisticsControl::getNoGoodPixelsMask);
116  cls.def("getNanSafe", &StatisticsControl::getNanSafe);
117  cls.def("getWeighted", &StatisticsControl::getWeighted);
118  cls.def("getWeightedIsSet", &StatisticsControl::getWeightedIsSet);
119  cls.def("getCalcErrorFromInputVariance", &StatisticsControl::getCalcErrorFromInputVariance);
120  cls.def("setNumSigmaClip", &StatisticsControl::setNumSigmaClip);
121  cls.def("setNumIter", &StatisticsControl::setNumIter);
122  cls.def("setAndMask", &StatisticsControl::setAndMask);
123  cls.def("setNoGoodPixelsMask", &StatisticsControl::setNoGoodPixelsMask);
124  cls.def("setNanSafe", &StatisticsControl::setNanSafe);
125  cls.def("setWeighted", &StatisticsControl::setWeighted);
126  cls.def("setCalcErrorFromInputVariance", &StatisticsControl::setCalcErrorFromInputVariance);
127  });
128 
129  wrappers.wrapType(py::enum_<StatisticsControl::WeightsBoolean>(control, "WeightsBoolean"),
130  [](auto &mod, auto &enm) {
131  enm.value("WEIGHTS_FALSE", StatisticsControl::WeightsBoolean::WEIGHTS_FALSE);
132  enm.value("WEIGHTS_TRUE", StatisticsControl::WeightsBoolean::WEIGHTS_TRUE);
133  enm.value("WEIGHTS_NONE", StatisticsControl::WeightsBoolean::WEIGHTS_NONE);
134  enm.export_values();
135  });
136 
137  wrappers.wrapType(py::class_<Statistics>(wrappers.module, "Statistics"), [](auto &mod, auto &cls) {
138  cls.def("getResult", &Statistics::getResult, "prop"_a = Property::NOTHING);
139  cls.def("getError", &Statistics::getError, "prop"_a = Property::NOTHING);
140  cls.def("getValue", &Statistics::getValue, "prop"_a = Property::NOTHING);
141  cls.def("getOrMask", &Statistics::getOrMask);
142  });
143 }
145  wrappers.addSignatureDependency("lsst.afw.image");
146  declareStatistics(wrappers);
147  declareStatistics<unsigned short>(wrappers);
148  declareStatistics<double>(wrappers);
149  declareStatistics<float>(wrappers);
150  declareStatistics<int>(wrappers);
151  // Declare vector overloads separately to prevent casting errors
152  // that otherwise (mysteriously) occur when overloads are tried
153  // in order.
154  declareStatisticsVectorOverloads<unsigned short>(wrappers);
155  declareStatisticsVectorOverloads<double>(wrappers);
156  declareStatisticsVectorOverloads<float>(wrappers);
157  declareStatisticsVectorOverloads<int>(wrappers);
158 }
159 } // namespace math
160 } // namespace afw
161 } // namespace lsst
Represent a 2-dimensional array of bitmask pixels.
Definition: Mask.h:77
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
Pass parameters to a Statistics object.
Definition: Statistics.h:93
A class to evaluate image statistics.
Definition: Statistics.h:215
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 wrap(WrapperCallback function)
Add a set of wrappers without defining a class.
Definition: python.h:369
void addSignatureDependency(std::string const &name)
Indicate an external module that provides a type used in function/method signatures.
Definition: python.h:357
void declareStatistics(lsst::utils::python::WrapperCollection &wrappers)
Definition: _statistics.cc:37
Statistics makeStatistics(lsst::afw::image::Image< Pixel > const &img, lsst::afw::image::Mask< image::MaskPixel > const &msk, int const flags, StatisticsControl const &sctrl=StatisticsControl())
Handle a watered-down front-end to the constructor (no variance)
Definition: Statistics.h:354
void wrapStatistics(lsst::utils::python::WrapperCollection &)
Definition: _statistics.cc:144
Property stringToStatisticsProperty(std::string const property)
Conversion function to switch a string to a Property (see Statistics.h)
Definition: Statistics.cc:747
void declareStatisticsVectorOverloads(lsst::utils::python::WrapperCollection &wrappers)
Definition: _statistics.cc:63
py::class_< PixelAreaBoundedField, std::shared_ptr< PixelAreaBoundedField >, BoundedField > PyClass
A base class for image defects.