LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
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 */
31
32namespace lsst {
33namespace afw {
34namespace math {
35
36namespace {
37
38template <typename T>
39struct do_random : public lsst::afw::image::pixelOp0<T> {
40 do_random(Random &rand) : _rand(rand) {}
41
42protected:
43 Random &_rand;
44};
45
46template <typename T>
47struct 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
53template <typename T>
54struct 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
60template <typename T>
61struct 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
66private:
67 unsigned long _n;
68};
69
70template <typename T>
71struct 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
76private:
77 double const _a;
78 double const _b;
79};
80
81template <typename T>
82struct 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
88template <typename T>
89struct 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
94private:
95 double const _nu;
96};
97
98template <typename T>
99struct 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
104private:
105 double const _mu;
106};
107} // namespace
108
109template <typename ImageT>
110void randomUniformImage(ImageT *image, Random &rand) {
111 lsst::afw::image::for_each_pixel(*image, do_uniform<typename ImageT::Pixel>(rand));
112}
113
114template <typename ImageT>
115void randomUniformPosImage(ImageT *image, Random &rand) {
116 lsst::afw::image::for_each_pixel(*image, do_uniformPos<typename ImageT::Pixel>(rand));
117}
118
119template <typename ImageT>
120void 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
124template <typename ImageT>
125void 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
129template <typename ImageT>
130void randomGaussianImage(ImageT *image, Random &rand) {
131 lsst::afw::image::for_each_pixel(*image, do_gaussian<typename ImageT::Pixel>(rand));
132}
133
134template <typename ImageT>
135void 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
139template <typename ImageT>
140void 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
158INSTANTIATE(double)
159INSTANTIATE(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 ... n - 1.
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()