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
RandomImage.cc
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 /*
26  * Fill Images with Random numbers
27  */
28 #include "lsst/afw/image/Image.h"
30 #include "lsst/afw/math/Random.h"
31 
32 namespace lsst {
33 namespace afw {
34 namespace math {
35 
36 namespace {
37 
38 template <typename T>
39 struct do_random : public lsst::afw::image::pixelOp0<T> {
40  do_random(Random &rand) : _rand(rand) {}
41 
42 protected:
43  Random &_rand;
44 };
45 
46 template <typename T>
47 struct do_uniform : public do_random<T> {
48  do_uniform(Random &rand) : do_random<T>(rand) {}
49 
50  T operator()() const override { return do_random<T>::_rand.uniform(); }
51 };
52 
53 template <typename T>
54 struct do_uniformPos : public do_random<T> {
55  do_uniformPos(Random &rand) : do_random<T>(rand) {}
56 
57  T operator()() const override { return do_random<T>::_rand.uniformPos(); }
58 };
59 
60 template <typename T>
61 struct do_uniformInt : public do_random<T> {
62  do_uniformInt(Random &rand, unsigned long n) : do_random<T>(rand), _n(n) {}
63 
64  T operator()() const override { return do_random<T>::_rand.uniformInt(_n); }
65 
66 private:
67  unsigned long _n;
68 };
69 
70 template <typename T>
71 struct do_flat : public do_random<T> {
72  do_flat(Random &rand, double const a, double const b) : do_random<T>(rand), _a(a), _b(b) {}
73 
74  T operator()() const override { return do_random<T>::_rand.flat(_a, _b); }
75 
76 private:
77  double const _a;
78  double const _b;
79 };
80 
81 template <typename T>
82 struct do_gaussian : public do_random<T> {
83  do_gaussian(Random &rand) : do_random<T>(rand) {}
84 
85  T operator()() const override { return do_random<T>::_rand.gaussian(); }
86 };
87 
88 template <typename T>
89 struct do_chisq : public do_random<T> {
90  do_chisq(Random &rand, double nu) : do_random<T>(rand), _nu(nu) {}
91 
92  T operator()() const override { return do_random<T>::_rand.chisq(_nu); }
93 
94 private:
95  double const _nu;
96 };
97 
98 template <typename T>
99 struct do_poisson : public do_random<T> {
100  do_poisson(Random &rand, double mu) : do_random<T>(rand), _mu(mu) {}
101 
102  T operator()() const override { return do_random<T>::_rand.poisson(_mu); }
103 
104 private:
105  double const _mu;
106 };
107 } // namespace
108 
109 template <typename ImageT>
110 void randomUniformImage(ImageT *image, Random &rand) {
111  lsst::afw::image::for_each_pixel(*image, do_uniform<typename ImageT::Pixel>(rand));
112 }
113 
114 template <typename ImageT>
115 void randomUniformPosImage(ImageT *image, Random &rand) {
116  lsst::afw::image::for_each_pixel(*image, do_uniformPos<typename ImageT::Pixel>(rand));
117 }
118 
119 template <typename ImageT>
120 void randomUniformIntImage(ImageT *image, Random &rand, unsigned long n) {
121  lsst::afw::image::for_each_pixel(*image, do_uniformInt<typename ImageT::Pixel>(rand, n));
122 }
123 
124 template <typename ImageT>
125 void randomFlatImage(ImageT *image, Random &rand, double const a, double const b) {
126  lsst::afw::image::for_each_pixel(*image, do_flat<typename ImageT::Pixel>(rand, a, b));
127 }
128 
129 template <typename ImageT>
130 void randomGaussianImage(ImageT *image, Random &rand) {
131  lsst::afw::image::for_each_pixel(*image, do_gaussian<typename ImageT::Pixel>(rand));
132 }
133 
134 template <typename ImageT>
135 void randomChisqImage(ImageT *image, Random &rand, double const nu) {
136  lsst::afw::image::for_each_pixel(*image, do_chisq<typename ImageT::Pixel>(rand, nu));
137 }
138 
139 template <typename ImageT>
140 void randomPoissonImage(ImageT *image, Random &rand, double const mu) {
141  lsst::afw::image::for_each_pixel(*image, do_poisson<typename ImageT::Pixel>(rand, mu));
142 }
143 
144 //
145 // Explicit instantiations
146 //
148 #define INSTANTIATE(T) \
149  template void randomUniformImage(lsst::afw::image::Image<T> *image, Random &rand); \
150  template void randomUniformPosImage(lsst::afw::image::Image<T> *image, Random &rand); \
151  template void randomUniformIntImage(lsst::afw::image::Image<T> *image, Random &rand, unsigned long n); \
152  template void randomFlatImage(lsst::afw::image::Image<T> *image, Random &rand, double const a, \
153  double const b); \
154  template void randomGaussianImage(lsst::afw::image::Image<T> *image, Random &rand); \
155  template void randomChisqImage(lsst::afw::image::Image<T> *image, Random &rand, double const nu); \
156  template void randomPoissonImage(lsst::afw::image::Image<T> *image, Random &rand, double const mu);
157 
158 INSTANTIATE(double)
159 INSTANTIATE(float)
161 } // namespace math
162 } // namespace afw
163 } // namespace lsst
#define INSTANTIATE(FROMSYS, TOSYS)
Definition: Detector.cc:484
Random & _rand
Definition: RandomImage.cc:43
table::Key< int > b
table::Key< int > a
A class that can be used to generate sequences of random numbers according to a number of different a...
Definition: Random.h:57
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
void for_each_pixel(Image< LhsT > &lhs, pixelOp0< LhsT > const &func)
Set each pixel in an Image<LhsT> to func()
void randomUniformImage(ImageT *image, Random &rand)
Set image to random numbers uniformly distributed in the range [0, 1)
Definition: RandomImage.cc:110
void randomPoissonImage(ImageT *image, Random &rand, double const mu)
Set image to random numbers with a Poisson distribution with mean mu (n.b.
Definition: RandomImage.cc:140
void randomGaussianImage(ImageT *image, Random &rand)
Set image to random numbers with a gaussian N(0, 1) distribution.
Definition: RandomImage.cc:130
void randomUniformPosImage(ImageT *image, Random &rand)
Set image to random numbers uniformly distributed in the range (0, 1)
Definition: RandomImage.cc:115
void randomFlatImage(ImageT *image, Random &rand, double const a, double const b)
Set image to random numbers uniformly distributed in the range [a, b)
Definition: RandomImage.cc:125
void randomChisqImage(ImageT *image, Random &rand, double const nu)
Set image to random numbers with a chi^2_{nu} distribution.
Definition: RandomImage.cc:135
void randomUniformIntImage(ImageT *image, Random &rand, unsigned long n)
Set image to random integers uniformly distributed in the range 0 ...
Definition: RandomImage.cc:120
A base class for image defects.
T rand(T... args)
A functor class equivalent to std::function<ValT ()>, but with a virtual operator()