LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
addToCoadd.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 
30 #include <cstdint>
31 #include <limits>
32 
33 #include "boost/format.hpp"
34 
35 #include "lsst/pex/exceptions.h"
36 #include "lsst/geom.h"
38 
40 namespace geom = lsst::geom;
41 namespace afwImage = lsst::afw::image;
42 namespace coaddUtils = lsst::coadd::utils;
43 
44 namespace {
45  /*
46  * A boolean functor to test if a MaskedImage pixel is valid (mask & badPixel == 0)
47  */
48  struct CheckMask {
49  CheckMask(lsst::afw::image::MaskPixel badPixel) : _badPixel(badPixel) {}
50 
51  template<typename T>
52  bool operator()(T val) const {
53  return ((val.mask() & _badPixel) == 0) ? true : false;
54  }
55  private:
57  };
58 
59  /*
60  * A boolean functor to test if an Image pixel has known value (not NaN)
61  */
62  struct CheckKnownValue {
63  CheckKnownValue(lsst::afw::image::MaskPixel) {}
64 
65  template<typename T>
66  bool operator()(T val) const {
67  return !std::isnan(static_cast<float>(*val));
68  }
69  };
70 
71  /*
72  * Implementation of addToCoadd
73  *
74  * The template parameter isValidPixel is a functor with operator()
75  * which returns true if a given image pixel is valid.
76  * This allows us to support multiple image types including
77  * MaskedImage with a mask bit and Image with a check for NaN.
78  *
79  * @return overlapping bounding box, relative to parent image
80  */
81  template <typename CoaddT, typename WeightPixelT, typename isValidPixel>
82  static lsst::geom::Box2I addToCoaddImpl(
83  CoaddT &coadd,
85  CoaddT const &image,
86  lsst::afw::image::MaskPixel const badPixelMask,
87  WeightPixelT weight
88  ) {
89  typedef typename afwImage::Image<WeightPixelT> WeightMapT;
90 
91  if (coadd.getBBox() != weightMap.getBBox()) {
93  (boost::format("coadd and weightMap parent bboxes differ: %s != %s") %
94  coadd.getBBox() % weightMap.getBBox()).str());
95  }
96 
97  geom::Box2I overlapBBox = coadd.getBBox();
98  overlapBBox.clip(image.getBBox());
99  if (overlapBBox.isEmpty()) {
100  return overlapBBox;
101  }
102 
103  CoaddT coaddView(coadd, overlapBBox, afwImage::PARENT, false);
104  WeightMapT weightMapView(weightMap, overlapBBox, afwImage::PARENT, false);
105  CoaddT imageView(image, overlapBBox, afwImage::PARENT, false);
106 
107  isValidPixel const isValid(badPixelMask); // functor to check if a pixel is good
108  for (int y = 0, endY = imageView.getHeight(); y != endY; ++y) {
109  typename CoaddT::const_x_iterator imageIter = imageView.row_begin(y);
110  typename CoaddT::const_x_iterator const imageEndIter = imageView.row_end(y);
111  typename CoaddT::x_iterator coaddIter = coaddView.row_begin(y);
112  typename WeightMapT::x_iterator weightMapIter = weightMapView.row_begin(y);
113  for (; imageIter != imageEndIter; ++imageIter, ++coaddIter, ++weightMapIter) {
114  if (isValid(imageIter)) {
115  typename CoaddT::SinglePixel pix = *imageIter;
116  pix *= typename CoaddT::Pixel(weight);
117  *coaddIter += pix;
118  *weightMapIter += weight;
119  }
120  }
121  }
122  return overlapBBox;
123  }
124 } // anonymous namespace
125 
126 template <typename CoaddPixelT, typename WeightPixelT>
128  // spell out lsst:afw::image to make Doxygen happy
132  WeightPixelT weight
133 ) {
135  return addToCoaddImpl<Image, WeightPixelT, CheckKnownValue>(coadd, weightMap, image, 0x0, weight);
136 }
137 
138 template <typename CoaddPixelT, typename WeightPixelT>
140  // spell out lsst:afw::image to make Doxygen happy
145  lsst::afw::image::VariancePixel> const &maskedImage,
146  lsst::afw::image::MaskPixel const badPixelMask,
147  WeightPixelT weight
148 ) {
150  return addToCoaddImpl<Image,WeightPixelT,CheckMask>(coadd, weightMap, maskedImage, badPixelMask, weight);
151 }
152 
153 // Explicit instantiations
154 
156 #define MASKEDIMAGE(IMAGEPIXEL) afwImage::MaskedImage<IMAGEPIXEL, \
157  afwImage::MaskPixel, afwImage::VariancePixel>
158 #define INSTANTIATE(COADDPIXEL, WEIGHTPIXEL) \
159  template lsst::geom::Box2I coaddUtils::addToCoadd<COADDPIXEL, WEIGHTPIXEL>( \
160  afwImage::Image<COADDPIXEL> &coadd, \
161  afwImage::Image<WEIGHTPIXEL> &weightMap, \
162  afwImage::Image<COADDPIXEL> const &image, \
163  WEIGHTPIXEL weight \
164  ); \
165  \
166  template lsst::geom::Box2I coaddUtils::addToCoadd<COADDPIXEL, WEIGHTPIXEL>( \
167  MASKEDIMAGE(COADDPIXEL) &coadd, \
168  afwImage::Image<WEIGHTPIXEL> &weightMap, \
169  MASKEDIMAGE(COADDPIXEL) const &image, \
170  afwImage::MaskPixel const badPixelMask, \
171  WEIGHTPIXEL weight \
172  );
173 
174 INSTANTIATE(double, double);
175 INSTANTIATE(double, float);
176 INSTANTIATE(double, int);
177 INSTANTIATE(double, std::uint16_t);
178 INSTANTIATE(float, double);
179 INSTANTIATE(float, float);
180 INSTANTIATE(float, int);
181 INSTANTIATE(float, std::uint16_t);
#define INSTANTIATE(FROMSYS, TOSYS)
Definition: Detector.cc:484
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
afw::table::Key< afw::table::Array< ImagePixelT > > image
int y
Definition: SpanSet.cc:48
lsst::geom::Box2I getBBox(ImageOrigin origin=PARENT) const
Definition: ImageBase.h:445
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
An integer coordinate rectangle.
Definition: Box.h:55
void clip(Box2I const &other) noexcept
Shrink this to ensure that other.contains(*this).
Definition: Box.cc:189
bool isEmpty() const noexcept
Return true if the box contains no points.
Definition: Box.h:213
Reports invalid arguments.
Definition: Runtime.h:66
bool isValid
Definition: fits.cc:399
T isnan(T... args)
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
float VariancePixel
default type for MaskedImage variance images
lsst::geom::Box2I addToCoadd(lsst::afw::image::Image< CoaddPixelT > &coadd, lsst::afw::image::Image< WeightPixelT > &weightMap, lsst::afw::image::Image< CoaddPixelT > const &image, WeightPixelT weight)
add good pixels from an image to a coadd and associated weight map
Definition: addToCoadd.cc:127
float Pixel
Typedefs to be used for pixel values.
Definition: common.h:37
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
afw::table::Key< double > weight
ImageT val
Definition: CR.cc:146