LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
40namespace geom = lsst::geom;
41namespace afwImage = lsst::afw::image;
43
44namespace {
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
126template <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
138template <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
174INSTANTIATE(double, double);
175INSTANTIATE(double, float);
176INSTANTIATE(double, int);
178INSTANTIATE(float, double);
179INSTANTIATE(float, float);
180INSTANTIATE(float, int);
#define INSTANTIATE(FROMSYS, TOSYS)
Definition Detector.cc:509
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
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:74
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:404
T isnan(T... args)
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
afw::table::Key< double > weight
ImageT val
Definition CR.cc:146