LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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,
55  int maxInterpolationDistance = 10
57  )
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;
76  int _maxInterpolationDistance;
78 };
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 
199 template <typename ImageT>
200 typename ImageT::SinglePixel edgePixel(lsst::afw::image::detail::Image_tag
202 ) {
203  using SinglePixelT = typename ImageT::SinglePixel;
206  : 0);
207 }
208 
220 template <typename MaskedImageT>
221 typename MaskedImageT::SinglePixel edgePixel(
224 ) {
225  using ImagePixelT = typename MaskedImageT::Image::Pixel;
226  using VariancePixelT = typename MaskedImageT::Variance::Pixel;
227 
230  : 0;
231  auto maskPixel = MaskedImageT::Mask::getPlaneBitMask("NO_DATA");
234  : 0;
235  return typename MaskedImageT::SinglePixel(imagePixel, maskPixel, variancePixel);
236 }
237 
238 /*
239  * Define inline functions
240  */
241 
258 template <typename OutImageT, typename InImageT>
259 inline typename OutImageT::SinglePixel convolveAtAPoint(
260  typename InImageT::const_xy_locator inImageLocator,
261  image::Image<Kernel::Pixel>::const_xy_locator kernelLocator, int kWidth, int kHeight) {
262  typename OutImageT::SinglePixel outValue = 0;
263  for (int kRow = 0; kRow != kHeight; ++kRow) {
265  kEnd = kernelLocator + image::detail::difference_type(kWidth, 0);
266  kernelLocator != kEnd; ++inImageLocator.x(), ++kernelLocator.x()) {
267  typename Kernel::Pixel const kVal = kernelLocator[0];
268  if (kVal != 0) {
269  outValue += *inImageLocator * kVal;
270  }
271  }
272 
273  inImageLocator += image::detail::difference_type(-kWidth, 1);
274  kernelLocator += image::detail::difference_type(-kWidth, 1);
275  }
276 
277  return outValue;
278 }
279 
294 template <typename OutImageT, typename InImageT>
295 inline typename OutImageT::SinglePixel convolveAtAPoint(typename InImageT::const_xy_locator inImageLocator,
296  std::vector<Kernel::Pixel> const& kernelXList,
297  std::vector<Kernel::Pixel> const& kernelYList) {
298  using k_iter = typename std::vector<Kernel::Pixel>::const_iterator;
299 
300  using OutT = typename OutImageT::SinglePixel;
301  OutT outValue = 0;
302  for (double kValY : kernelYList) {
303  OutT outValueY = 0;
304  for (k_iter kernelXIter = kernelXList.begin(), xEnd = kernelXList.end(); kernelXIter != xEnd;
305  ++kernelXIter, ++inImageLocator.x()) {
306  typename Kernel::Pixel const kValX = *kernelXIter;
307  if (kValX != 0) {
308  outValueY += *inImageLocator * kValX;
309  }
310  }
311 
312  if (kValY != 0) {
313  outValue += outValueY * kValY;
314  }
315 
316  inImageLocator += image::detail::difference_type(-kernelXList.size(), 1);
317  }
318 
319  return outValue;
320 }
321 } // namespace math
322 } // namespace afw
323 } // namespace lsst
324 
325 #endif // !defined(LSST_AFW_MATH_CONVOLVEIMAGE_H)
T begin(T... args)
typename _view_t::xy_locator::const_t const_xy_locator
A const_xy_locator.
Definition: ImageBase.h:123
Parameters to control convolution.
Definition: ConvolveImage.h:50
void setDoCopyEdge(bool doCopyEdge)
Definition: ConvolveImage.h:67
void setDoNormalize(bool doNormalize)
Definition: ConvolveImage.h:66
ConvolutionControl(bool doNormalize=true, bool doCopyEdge=false, int maxInterpolationDistance=10)
Definition: ConvolveImage.h:52
void setMaxInterpolationDistance(int maxInterpolationDistance)
Definition: ConvolveImage.h:68
T end(T... args)
T infinity(T... args)
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.
void scaledPlus(OutImageT &outImage, double c1, InImageT const &inImage1, double c2, InImageT const &inImage2)
Compute the scaled sum of two images.
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.
ImageT::SinglePixel edgePixel(lsst::afw::image::detail::Image_tag)
Return an off-the-edge pixel appropriate for a given Image type.
float Pixel
Typedefs to be used for pixel values.
Definition: common.h:37
A base class for image defects.
T quiet_NaN(T... args)
T size(T... args)
A traits class for MaskedImage.
Definition: MaskedImage.h:50