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
ConvolveImage.h
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 #ifndef LSST_AFW_MATH_CONVOLVEIMAGE_H
26 #define LSST_AFW_MATH_CONVOLVEIMAGE_H
27 /*
28  * Convolve and convolveAtAPoint functions for Image and Kernel
29  *
30  * @todo Consider adding a flag to convolve indicating which specialized version of basicConvolve was used.
31  * This would only be used for unit testing and trace messages suffice (barely), so not a high priority.
32  */
33 #include <limits>
34 #include <sstream>
35 
36 #include "lsst/pex/exceptions.h"
37 #include "lsst/afw/image/Image.h"
39 #include "lsst/afw/math/Kernel.h"
40 
41 namespace lsst {
42 namespace afw {
43 namespace math {
44 
51 public:
52  ConvolutionControl(bool doNormalize = true,
53  bool doCopyEdge = false,
54  int maxInterpolationDistance = 10
56  )
58  : _doNormalize(doNormalize),
59  _doCopyEdge(doCopyEdge),
60  _maxInterpolationDistance(maxInterpolationDistance) {}
61 
62  bool getDoNormalize() const { return _doNormalize; }
63  bool getDoCopyEdge() const { return _doCopyEdge; }
64  int getMaxInterpolationDistance() const { return _maxInterpolationDistance; };
65 
66  void setDoNormalize(bool doNormalize) { _doNormalize = doNormalize; }
67  void setDoCopyEdge(bool doCopyEdge) { _doCopyEdge = doCopyEdge; }
68  void setMaxInterpolationDistance(int maxInterpolationDistance) {
69  _maxInterpolationDistance = maxInterpolationDistance;
70  }
71 
72 private:
73  bool _doNormalize;
74  bool _doCopyEdge;
75  int _maxInterpolationDistance;
77 };
79 
102 template <typename OutImageT, typename InImageT>
103 void scaledPlus(OutImageT& outImage, double c1, InImageT const& inImage1, double c2,
104  InImageT const& inImage2);
105 
106 template <typename OutImageT, typename InImageT>
107 inline typename OutImageT::SinglePixel convolveAtAPoint(
108  typename InImageT::const_xy_locator inImageLocator,
110  int kWidth, int kHeight);
111 
112 template <typename OutImageT, typename InImageT>
113 inline typename OutImageT::SinglePixel convolveAtAPoint(
114  typename InImageT::const_xy_locator inImageLocator,
115  std::vector<lsst::afw::math::Kernel::Pixel> const& kernelColList,
116  std::vector<lsst::afw::math::Kernel::Pixel> const& kernelRowList);
117 
190 template <typename OutImageT, typename InImageT, typename KernelT>
191 void convolve(OutImageT& convolvedImage, InImageT const& inImage, KernelT const& kernel,
192  ConvolutionControl const& convolutionControl = ConvolutionControl());
193 
206 template <typename OutImageT, typename InImageT, typename KernelT>
207 void convolve(OutImageT& convolvedImage, InImageT const& inImage, KernelT const& kernel, bool doNormalize,
208  bool doCopyEdge = false);
209 
215 template <typename ImageT>
216 typename ImageT::SinglePixel edgePixel(lsst::afw::image::detail::Image_tag
218 ) {
219  typedef typename ImageT::SinglePixel SinglePixelT;
222  : 0);
223 }
224 
236 template <typename MaskedImageT>
237 typename MaskedImageT::SinglePixel edgePixel(
240 ) {
241  typedef typename MaskedImageT::Image::Pixel ImagePixelT;
242  typedef typename MaskedImageT::Variance::Pixel VariancePixelT;
243 
246  : 0;
247  auto maskPixel = MaskedImageT::Mask::getPlaneBitMask("NO_DATA");
250  : 0;
251  return typename MaskedImageT::SinglePixel(imagePixel, maskPixel, variancePixel);
252 }
253 
254 /*
255  * Define inline functions
256  */
257 
274 template <typename OutImageT, typename InImageT>
275 inline typename OutImageT::SinglePixel convolveAtAPoint(
276  typename InImageT::const_xy_locator inImageLocator,
277  image::Image<Kernel::Pixel>::const_xy_locator kernelLocator, int kWidth, int kHeight) {
278  typename OutImageT::SinglePixel outValue = 0;
279  for (int kRow = 0; kRow != kHeight; ++kRow) {
281  kEnd = kernelLocator + image::detail::difference_type(kWidth, 0);
282  kernelLocator != kEnd; ++inImageLocator.x(), ++kernelLocator.x()) {
283  typename Kernel::Pixel const kVal = kernelLocator[0];
284  if (kVal != 0) {
285  outValue += *inImageLocator * kVal;
286  }
287  }
288 
289  inImageLocator += image::detail::difference_type(-kWidth, 1);
290  kernelLocator += image::detail::difference_type(-kWidth, 1);
291  }
292 
293  return outValue;
294 }
295 
310 template <typename OutImageT, typename InImageT>
311 inline typename OutImageT::SinglePixel convolveAtAPoint(typename InImageT::const_xy_locator inImageLocator,
312  std::vector<Kernel::Pixel> const& kernelXList,
313  std::vector<Kernel::Pixel> const& kernelYList) {
314  typedef typename std::vector<Kernel::Pixel>::const_iterator k_iter;
315 
316  typedef typename OutImageT::SinglePixel OutT;
317  OutT outValue = 0;
318  for (k_iter kernelYIter = kernelYList.begin(), yEnd = kernelYList.end(); kernelYIter != yEnd;
319  ++kernelYIter) {
320  OutT outValueY = 0;
321  for (k_iter kernelXIter = kernelXList.begin(), xEnd = kernelXList.end(); kernelXIter != xEnd;
322  ++kernelXIter, ++inImageLocator.x()) {
323  typename Kernel::Pixel const kValX = *kernelXIter;
324  if (kValX != 0) {
325  outValueY += *inImageLocator * kValX;
326  }
327  }
328 
329  double const kValY = *kernelYIter;
330  if (kValY != 0) {
331  outValue += outValueY * kValY;
332  }
333 
334  inImageLocator += image::detail::difference_type(-kernelXList.size(), 1);
335  }
336 
337  return outValue;
338 }
339 } // namespace math
340 } // namespace afw
341 } // namespace lsst
342 
343 #endif // !defined(LSST_AFW_MATH_CONVOLVEIMAGE_H)
void scaledPlus(OutImageT &outImage, double c1, InImageT const &inImage1, double c2, InImageT const &inImage2)
Compute the scaled sum of two images.
float Pixel
Typedefs to be used for pixel values.
Definition: common.h:37
Parameters to control convolution.
Definition: ConvolveImage.h:50
void setDoCopyEdge(bool doCopyEdge)
Definition: ConvolveImage.h:67
T end(T... args)
void setDoNormalize(bool doNormalize)
Definition: ConvolveImage.h:66
OutImageT::SinglePixel convolveAtAPoint(typename InImageT::const_xy_locator inImageLocator, typename lsst::afw::image::Image< lsst::afw::math::Kernel::Pixel >::const_xy_locator kernelLocator, int kWidth, int kHeight)
Apply convolution kernel to an image at one point.
A base class for image defects.
ConvolutionControl(bool doNormalize=true, bool doCopyEdge=false, int maxInterpolationDistance=10)
Definition: ConvolveImage.h:52
A traits class for MaskedImage.
Definition: MaskedImage.h:50
void setMaxInterpolationDistance(int maxInterpolationDistance)
Definition: ConvolveImage.h:68
ImageT::SinglePixel edgePixel(lsst::afw::image::detail::Image_tag)
Return an off-the-edge pixel appropriate for a given Image type.
void convolve(OutImageT &convolvedImage, InImageT const &inImage, KernelT const &kernel, ConvolutionControl const &convolutionControl=ConvolutionControl())
Convolve an Image or MaskedImage with a Kernel, setting pixels of an existing output image...
T infinity(T... args)
_view_t::xy_locator::const_t const_xy_locator
A const_xy_locator.
Definition: ImageBase.h:123
T size(T... args)
STL class.
T begin(T... args)
T quiet_NaN(T... args)