LSST Applications  21.0.0+c4f5df5339,21.0.0+e70536a077,21.0.0-1-ga51b5d4+7c60f8a6ea,21.0.0-10-gcf60f90+74aa0801fd,21.0.0-12-g63909ac9+643a1044a5,21.0.0-15-gedb9d5423+1041c3824f,21.0.0-2-g103fe59+a356b2badb,21.0.0-2-g1367e85+6d3f3f41db,21.0.0-2-g45278ab+e70536a077,21.0.0-2-g5242d73+6d3f3f41db,21.0.0-2-g7f82c8f+8d7c04eab9,21.0.0-2-g8f08a60+9c9a9cfcc8,21.0.0-2-ga326454+8d7c04eab9,21.0.0-2-gde069b7+bedfc5e1fb,21.0.0-2-gecfae73+6cb6558258,21.0.0-2-gfc62afb+6d3f3f41db,21.0.0-3-g21c7a62+f6e98b25aa,21.0.0-3-g357aad2+bd62456bea,21.0.0-3-g4be5c26+6d3f3f41db,21.0.0-3-g65f322c+03a4076c01,21.0.0-3-g7d9da8d+c4f5df5339,21.0.0-3-gaa929c8+c6b98066dc,21.0.0-3-gc44e71e+a26d5c1aea,21.0.0-3-ge02ed75+04b527a9d5,21.0.0-35-g64f566ff+b27e5ef93e,21.0.0-4-g591bb35+04b527a9d5,21.0.0-4-g88306b8+8773047b2e,21.0.0-4-gc004bbf+80a0b7acb7,21.0.0-4-gccdca77+a5c54364a0,21.0.0-4-ge8fba5a+ccfc328107,21.0.0-5-gdf36809+87b8d260e6,21.0.0-6-g00874e7+7eeda2b6ba,21.0.0-6-g2d4f3f3+e70536a077,21.0.0-6-g4e60332+04b527a9d5,21.0.0-6-g5ef7dad+f53629abd8,21.0.0-7-gc8ca178+b63e69433b,21.0.0-8-gfbe0b4b+c6b98066dc,w.2021.06
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 <pybind11/operators.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 
35 template <typename ImageT>
37  mod.def("randomUniformImage", (void (*)(ImageT *, Random &))randomUniformImage<ImageT>);
38  mod.def("randomUniformPosImage", (void (*)(ImageT *, Random &))randomUniformPosImage<ImageT>);
39  mod.def("randomUniformIntImage",
40  (void (*)(ImageT *, Random &, unsigned long))randomUniformIntImage<ImageT>);
41  mod.def("randomFlatImage",
42  (void (*)(ImageT *, Random &, double const, double const))randomFlatImage<ImageT>);
43  mod.def("randomGaussianImage", (void (*)(ImageT *, Random &))randomGaussianImage<ImageT>);
44  mod.def("randomChisqImage", (void (*)(ImageT *, Random &, double const))randomChisqImage<ImageT>);
45  mod.def("randomPoissonImage", (void (*)(ImageT *, Random &, double const))randomPoissonImage<ImageT>);
46 }
47 
48 PYBIND11_MODULE(random, mod) {
49  py::class_<Random> clsRandom(mod, "Random");
50 
51  /* Member types and enums */
52  py::enum_<Random::Algorithm>(clsRandom, "Algorithm")
53  .value("MT19937", Random::Algorithm::MT19937)
54  .value("RANLXS0", Random::Algorithm::RANLXS0)
55  .value("RANLXS1", Random::Algorithm::RANLXS1)
56  .value("RANLXS2", Random::Algorithm::RANLXS2)
57  .value("RANLXD1", Random::Algorithm::RANLXD1)
58  .value("RANLXD2", Random::Algorithm::RANLXD2)
59  .value("RANLUX", Random::Algorithm::RANLUX)
60  .value("RANLUX389", Random::Algorithm::RANLUX389)
61  .value("CMRG", Random::Algorithm::CMRG)
62  .value("MRG", Random::Algorithm::MRG)
63  .value("TAUS", Random::Algorithm::TAUS)
64  .value("TAUS2", Random::Algorithm::TAUS2)
65  .value("GFSR4", Random::Algorithm::GFSR4)
66  .value("NUM_ALGORITHMS", Random::Algorithm::NUM_ALGORITHMS)
67  .export_values();
68 
69  /* Constructors */
70  clsRandom.def(py::init<Random::Algorithm, unsigned long>(), "algorithm"_a = Random::Algorithm::MT19937,
71  "seed"_a = 1);
72  clsRandom.def(py::init<std::string const &, unsigned long>(), "algorithm"_a, "seed"_a = 1);
73 
74  /* Members */
75  clsRandom.def("deepCopy", &Random::deepCopy);
76  clsRandom.def("getAlgorithm", &Random::getAlgorithm);
77  clsRandom.def("getAlgorithmName", &Random::getAlgorithmName);
78  clsRandom.def_static("getAlgorithmNames", &Random::getAlgorithmNames);
79  clsRandom.def("getSeed", &Random::getSeed);
80  clsRandom.def("uniform", &Random::uniform);
81  clsRandom.def("uniformPos", &Random::uniformPos);
82  clsRandom.def("uniformInt", &Random::uniformInt);
83  clsRandom.def("flat", &Random::flat);
84  clsRandom.def("gaussian", &Random::gaussian);
85  clsRandom.def("chisq", &Random::chisq);
86  clsRandom.def("poisson", &Random::poisson);
87 
88  // getState and setState are special, their std::string cannot
89  // be converted to a Python string (needs to go to bytes instead)
90  // thus use the same solution as employed with Swig
91  clsRandom.def("getState", [](Random &self) -> py::object {
92  std::string state = self.getState();
93  return py::reinterpret_steal<py::object>(PyBytes_FromStringAndSize(state.data(), state.size()));
94  });
95  clsRandom.def("setState", [](Random &self, py::bytes const &state) { self.setState(state); });
96 
97  /* Module level */
98  declareRandomImage<lsst::afw::image::Image<double>>(mod);
99  declareRandomImage<lsst::afw::image::Image<float>>(mod);
100 }
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
double uniformPos()
Returns a uniformly distributed random double precision floating point number from the generator.
Definition: Random.cc:148
double chisq(double const nu)
Returns a random variate from the chi-squared distribution with nu degrees of freedom.
Definition: Random.cc:163
Random deepCopy() const
Creates a deep copy of this random number generator.
Definition: Random.cc:100
static std::vector< std::string > const & getAlgorithmNames()
Definition: Random.cc:132
double poisson(double const mu)
Returns a random variate from the poisson distribution with mean mu.
Definition: Random.cc:165
Algorithm getAlgorithm() const
Definition: Random.cc:128
std::string getAlgorithmName() const
Definition: Random.cc:130
unsigned long getSeed() const
Definition: Random.cc:142
double gaussian()
Returns a gaussian random variate with mean 0 and standard deviation 1
Definition: Random.cc:161
double uniform()
Returns a uniformly distributed random double precision floating point number from the generator.
Definition: Random.cc:146
unsigned long uniformInt(unsigned long n)
Returns a uniformly distributed random integer from 0 to n-1.
Definition: Random.cc:150
double flat(double const a, double const b)
Returns a random variate from the flat (uniform) distribution on [a, b).
Definition: Random.cc:159
T data(T... args)
PYBIND11_MODULE(approximate, mod)
Definition: approximate.cc:56
void declareRandomImage(py::module &mod)
Definition: random.cc:36
T size(T... args)