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
_random.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"
28 #include "lsst/afw/math/Random.h"
29 
30 namespace py = pybind11;
31 
32 using namespace lsst::afw::math;
33 using namespace pybind11::literals;
34 namespace lsst {
35 namespace afw {
36 namespace math {
37 template <typename ImageT>
38 void declareRandomImage(lsst::utils::python::WrapperCollection &wrappers) {
39  wrappers.wrap([](auto &mod) {
40  mod.def("randomUniformImage", (void (*)(ImageT *, Random &))randomUniformImage<ImageT>);
41  mod.def("randomUniformPosImage", (void (*)(ImageT *, Random &))randomUniformPosImage<ImageT>);
42  mod.def("randomUniformIntImage",
43  (void (*)(ImageT *, Random &, unsigned long))randomUniformIntImage<ImageT>);
44  mod.def("randomFlatImage",
45  (void (*)(ImageT *, Random &, double const, double const))randomFlatImage<ImageT>);
46  mod.def("randomGaussianImage", (void (*)(ImageT *, Random &))randomGaussianImage<ImageT>);
47  mod.def("randomChisqImage", (void (*)(ImageT *, Random &, double const))randomChisqImage<ImageT>);
48  mod.def("randomPoissonImage", (void (*)(ImageT *, Random &, double const))randomPoissonImage<ImageT>);
49  });
50 }
51 
52 void declareRandom(lsst::utils::python::WrapperCollection &wrappers) {
53  auto clsRandom = wrappers.wrapType(py::class_<Random>(wrappers.module, "Random"), [](auto &mod,
54  auto &cls) {
55  /* Constructors */
56  cls.def(py::init<Random::Algorithm, unsigned long>(), "algorithm"_a = Random::Algorithm::MT19937,
57  "seed"_a = 1);
58  cls.def(py::init<std::string const &, unsigned long>(), "algorithm"_a, "seed"_a = 1);
59 
60  /* Members */
61  cls.def("deepCopy", &Random::deepCopy);
62  cls.def("getAlgorithm", &Random::getAlgorithm);
63  cls.def("getAlgorithmName", &Random::getAlgorithmName);
64  cls.def_static("getAlgorithmNames", &Random::getAlgorithmNames);
65  cls.def("getSeed", &Random::getSeed);
66  cls.def("uniform", &Random::uniform);
67  cls.def("uniformPos", &Random::uniformPos);
68  cls.def("uniformInt", &Random::uniformInt);
69  cls.def("flat", &Random::flat);
70  cls.def("gaussian", &Random::gaussian);
71  cls.def("chisq", &Random::chisq);
72  cls.def("poisson", &Random::poisson);
73 
74  // getState and setState are special, their std::string cannot
75  // be converted to a Python string (needs to go to bytes instead)
76  // thus use the same solution as employed with Swig
77  cls.def("getState", [](Random &self) -> py::object {
78  std::string state = self.getState();
79  return py::reinterpret_steal<py::object>(PyBytes_FromStringAndSize(state.data(), state.size()));
80  });
81  cls.def("setState", [](Random &self, py::bytes const &state) { self.setState(state); });
82  });
83  /* Member types and enums */
84  wrappers.wrapType(py::enum_<Random::Algorithm>(clsRandom, "Algorithm"), [](auto &mod, auto &enm) {
85  enm.value("MT19937", Random::Algorithm::MT19937);
86  enm.value("RANLXS0", Random::Algorithm::RANLXS0);
87  enm.value("RANLXS1", Random::Algorithm::RANLXS1);
88  enm.value("RANLXS2", Random::Algorithm::RANLXS2);
89  enm.value("RANLXD1", Random::Algorithm::RANLXD1);
90  enm.value("RANLXD2", Random::Algorithm::RANLXD2);
91  enm.value("RANLUX", Random::Algorithm::RANLUX);
92  enm.value("RANLUX389", Random::Algorithm::RANLUX389);
93  enm.value("CMRG", Random::Algorithm::CMRG);
94  enm.value("MRG", Random::Algorithm::MRG);
95  enm.value("TAUS", Random::Algorithm::TAUS);
96  enm.value("TAUS2", Random::Algorithm::TAUS2);
97  enm.value("GFSR4", Random::Algorithm::GFSR4);
98  enm.value("NUM_ALGORITHMS", Random::Algorithm::NUM_ALGORITHMS);
99  enm.export_values();
100  });
101 }
102 
103 void wrapRandom(lsst::utils::python::WrapperCollection &wrappers) {
104  wrappers.addSignatureDependency("lsst.afw.image");
105  declareRandom(wrappers);
106  declareRandomImage<lsst::afw::image::Image<double>>(wrappers);
107  declareRandomImage<lsst::afw::image::Image<float>>(wrappers);
108 }
109 } // namespace math
110 } // namespace afw
111 } // namespace lsst
table::Key< table::Array< std::uint8_t > > bytes
Definition: python.h:135
A class that can be used to generate sequences of random numbers according to a number of different a...
Definition: Random.h:57
void wrapRandom(lsst::utils::python::WrapperCollection &)
Definition: _random.cc:103
void declareRandomImage(lsst::utils::python::WrapperCollection &wrappers)
Definition: _random.cc:38
void declareRandom(lsst::utils::python::WrapperCollection &wrappers)
Definition: _random.cc:52
A base class for image defects.