LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
LSSTDataManagementBasePackage
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);
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
afw::table::Key< afw::table::Array< ImagePixelT > > image
float Pixel
Typedefs to be used for pixel values.
Definition: common.h:37
int y
Definition: SpanSet.cc:49
ImageT val
Definition: CR.cc:146
ImageT::SinglePixel badPixel(typename ImageT::Pixel bad=0)
Return a value indicating a bad pixel for the given Image type.
Definition: Utils.h:77
lsst::geom::Box2I getBBox(ImageOrigin origin=PARENT) const
Definition: ImageBase.h:462
bool isValid
Definition: fits.cc:398
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
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
afw::table::Key< double > weight
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
void clip(Box2I const &other) noexcept
Shrink this to ensure that other.contains(*this).
Definition: Box.cc:189
Reports invalid arguments.
Definition: Runtime.h:66
T isnan(T... args)
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects...
float VariancePixel
default type for MaskedImage variance images
An integer coordinate rectangle.
Definition: Box.h:55
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:58
#define INSTANTIATE(FROMSYS, TOSYS)
Definition: Detector.cc:484