LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
copyGoodPixels.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/afw/geom.h"
38 
40 namespace afwGeom = lsst::afw::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 copyGoodPixels
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 ImageT, typename isValidPixel>
82  int copyGoodPixelsImpl(
83  ImageT &destImage,
84  ImageT const &srcImage,
85  lsst::afw::image::MaskPixel const badPixelMask
86  ) {
87  afwGeom::Box2I overlapBBox = destImage.getBBox();
88  overlapBBox.clip(srcImage.getBBox());
89  if (overlapBBox.isEmpty()) {
90  return 0;
91  }
92 
93  ImageT destView(destImage, overlapBBox, afwImage::PARENT, false);
94  ImageT srcView(srcImage, overlapBBox, afwImage::PARENT, false);
95 
96  isValidPixel const isValid(badPixelMask); // functor to check if a pixel is good
97  int numGoodPix = 0;
98  for (int y = 0, endY = srcView.getHeight(); y != endY; ++y) {
99  typename ImageT::const_x_iterator srcIter = srcView.row_begin(y);
100  typename ImageT::const_x_iterator const srcEndIter = srcView.row_end(y);
101  typename ImageT::x_iterator destIter = destView.row_begin(y);
102  for (; srcIter != srcEndIter; ++srcIter, ++destIter) {
103  if (isValid(srcIter)) {
104  *destIter = *srcIter;
105 // typename ImageT::SinglePixel pix = *srcIter;
106 // *destIter = pix;
107  ++numGoodPix;
108  }
109  }
110  }
111  return numGoodPix;
112  }
113 } // anonymous namespace
114 
115 template <typename ImagePixelT>
117  // spell out lsst:afw::image to make Doxygen happy
120 ) {
122  return copyGoodPixelsImpl<Image, CheckKnownValue>(destImage, srcImage, 0x0);
123 }
124 
125 template <typename ImagePixelT>
127  // spell out lsst:afw::image to make Doxygen happy
131  lsst::afw::image::VariancePixel> const &srcImage,
132  lsst::afw::image::MaskPixel const badPixelMask
133 ) {
135  return copyGoodPixelsImpl<Image, CheckMask>(destImage, srcImage, badPixelMask);
136 }
137 
138 // Explicit instantiations
139 
141 #define MASKEDIMAGE(IMAGEPIXEL) afwImage::MaskedImage<IMAGEPIXEL, \
142  afwImage::MaskPixel, afwImage::VariancePixel>
143 #define INSTANTIATE(IMAGEPIXEL) \
144  template int coaddUtils::copyGoodPixels<IMAGEPIXEL>( \
145  afwImage::Image<IMAGEPIXEL> &destImage, \
146  afwImage::Image<IMAGEPIXEL> const &srcImage \
147  ); \
148  \
149  template int coaddUtils::copyGoodPixels<IMAGEPIXEL>( \
150  MASKEDIMAGE(IMAGEPIXEL) &destImage, \
151  MASKEDIMAGE(IMAGEPIXEL) const &srcImage, \
152  afwImage::MaskPixel const badPixelMask \
153  );
154 
155 INSTANTIATE(double);
156 INSTANTIATE(float);
157 INSTANTIATE(int);
bool isEmpty() const noexcept
Return true if the box contains no points.
Definition: Box.h:194
int y
Definition: SpanSet.cc:49
int copyGoodPixels(lsst::afw::image::Image< ImagePixelT > &destImage, lsst::afw::image::Image< ImagePixelT > const &srcImage)
copy good pixels from one image to another
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:78
bool isValid
Definition: fits.cc:380
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:74
void clip(Box2I const &other) noexcept
Shrink this to ensure that other.contains(*this).
Definition: Box.cc:194
afw::table::Key< afw::table::Array< ImagePixelT > > image
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:54
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:59
#define INSTANTIATE(FROMSYS, TOSYS)
Definition: Detector.cc:349