LSSTApplications  20.0.0
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 [[deprecated("Use `convolve` with a `ConvolutionControl` instead. To be removed after 20.0.0.")]] // DM-22814
208  void
209  convolve(OutImageT& convolvedImage, InImageT const& inImage, KernelT const& kernel, bool doNormalize,
210  bool doCopyEdge = false);
211 
217 template <typename ImageT>
218 typename ImageT::SinglePixel edgePixel(lsst::afw::image::detail::Image_tag
220 ) {
221  typedef typename ImageT::SinglePixel SinglePixelT;
224  : 0);
225 }
226 
238 template <typename MaskedImageT>
239 typename MaskedImageT::SinglePixel edgePixel(
242 ) {
243  typedef typename MaskedImageT::Image::Pixel ImagePixelT;
244  typedef typename MaskedImageT::Variance::Pixel VariancePixelT;
245 
248  : 0;
249  auto maskPixel = MaskedImageT::Mask::getPlaneBitMask("NO_DATA");
252  : 0;
253  return typename MaskedImageT::SinglePixel(imagePixel, maskPixel, variancePixel);
254 }
255 
256 /*
257  * Define inline functions
258  */
259 
276 template <typename OutImageT, typename InImageT>
277 inline typename OutImageT::SinglePixel convolveAtAPoint(
278  typename InImageT::const_xy_locator inImageLocator,
279  image::Image<Kernel::Pixel>::const_xy_locator kernelLocator, int kWidth, int kHeight) {
280  typename OutImageT::SinglePixel outValue = 0;
281  for (int kRow = 0; kRow != kHeight; ++kRow) {
283  kEnd = kernelLocator + image::detail::difference_type(kWidth, 0);
284  kernelLocator != kEnd; ++inImageLocator.x(), ++kernelLocator.x()) {
285  typename Kernel::Pixel const kVal = kernelLocator[0];
286  if (kVal != 0) {
287  outValue += *inImageLocator * kVal;
288  }
289  }
290 
291  inImageLocator += image::detail::difference_type(-kWidth, 1);
292  kernelLocator += image::detail::difference_type(-kWidth, 1);
293  }
294 
295  return outValue;
296 }
297 
312 template <typename OutImageT, typename InImageT>
313 inline typename OutImageT::SinglePixel convolveAtAPoint(typename InImageT::const_xy_locator inImageLocator,
314  std::vector<Kernel::Pixel> const& kernelXList,
315  std::vector<Kernel::Pixel> const& kernelYList) {
316  typedef typename std::vector<Kernel::Pixel>::const_iterator k_iter;
317 
318  typedef typename OutImageT::SinglePixel OutT;
319  OutT outValue = 0;
320  for (k_iter kernelYIter = kernelYList.begin(), yEnd = kernelYList.end(); kernelYIter != yEnd;
321  ++kernelYIter) {
322  OutT outValueY = 0;
323  for (k_iter kernelXIter = kernelXList.begin(), xEnd = kernelXList.end(); kernelXIter != xEnd;
324  ++kernelXIter, ++inImageLocator.x()) {
325  typename Kernel::Pixel const kValX = *kernelXIter;
326  if (kValX != 0) {
327  outValueY += *inImageLocator * kValX;
328  }
329  }
330 
331  double const kValY = *kernelYIter;
332  if (kValY != 0) {
333  outValue += outValueY * kValY;
334  }
335 
336  inImageLocator += image::detail::difference_type(-kernelXList.size(), 1);
337  }
338 
339  return outValue;
340 }
341 } // namespace math
342 } // namespace afw
343 } // namespace lsst
344 
345 #endif // !defined(LSST_AFW_MATH_CONVOLVEIMAGE_H)
lsst::afw::math::ConvolutionControl::setDoNormalize
void setDoNormalize(bool doNormalize)
Definition: ConvolveImage.h:66
lsst::afw::math::scaledPlus
void scaledPlus(OutImageT &outImage, double c1, InImageT const &inImage1, double c2, InImageT const &inImage2)
Compute the scaled sum of two images.
Definition: ConvolveImage.cc:162
lsst::meas::modelfit::Pixel
float Pixel
Typedefs to be used for pixel values.
Definition: common.h:37
std::numeric_limits::quiet_NaN
T quiet_NaN(T... args)
MaskedImage.h
std::vector
STL class.
std::vector::size
T size(T... args)
lsst::afw::math::ConvolutionControl::getMaxInterpolationDistance
int getMaxInterpolationDistance() const
Definition: ConvolveImage.h:64
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::math::ConvolutionControl::setDoCopyEdge
void setDoCopyEdge(bool doCopyEdge)
Definition: ConvolveImage.h:67
lsst::afw::math::ConvolutionControl::getDoCopyEdge
bool getDoCopyEdge() const
Definition: ConvolveImage.h:63
lsst::afw::math::ConvolutionControl::setMaxInterpolationDistance
void setMaxInterpolationDistance(int maxInterpolationDistance)
Definition: ConvolveImage.h:68
Image.h
lsst::afw::math::convolveAtAPoint
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.
Definition: ConvolveImage.h:277
lsst::afw::image::detail::MaskedImage_tag
A traits class for MaskedImage.
Definition: MaskedImage.h:50
std::numeric_limits::infinity
T infinity(T... args)
lsst::afw::math::ConvolutionControl::getDoNormalize
bool getDoNormalize() const
Definition: ConvolveImage.h:62
lsst::afw::math::edgePixel
ImageT::SinglePixel edgePixel(lsst::afw::image::detail::Image_tag)
Return an off-the-edge pixel appropriate for a given Image type.
Definition: ConvolveImage.h:218
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::math::convolve
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.
Definition: ConvolveImage.cc:190
lsst::afw::image::detail::Image_tag
tag for an Image
Definition: ImageBase.h:63
lsst::afw::math::ConvolutionControl
Parameters to control convolution.
Definition: ConvolveImage.h:50
std::vector::begin
T begin(T... args)
Kernel.h
lsst::afw::math::ConvolutionControl::ConvolutionControl
ConvolutionControl(bool doNormalize=true, bool doCopyEdge=false, int maxInterpolationDistance=10)
Definition: ConvolveImage.h:52
std::vector::end
T end(T... args)
std::numeric_limits
exceptions.h
lsst::afw::image::ImageBase::const_xy_locator
_view_t::xy_locator::const_t const_xy_locator
A const_xy_locator.
Definition: ImageBase.h:123
lsst::afw::math::Kernel::Pixel
double Pixel
Definition: Kernel.h:113