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
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"
40
41namespace lsst {
42namespace afw {
43namespace math {
44
51public:
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
72private:
73 bool _doNormalize;
74 bool _doCopyEdge;
76 int _maxInterpolationDistance;
78};
79
102template <typename OutImageT, typename InImageT>
103void scaledPlus(OutImageT& outImage, double c1, InImageT const& inImage1, double c2,
104 InImageT const& inImage2);
105
106template <typename OutImageT, typename InImageT>
107inline typename OutImageT::SinglePixel convolveAtAPoint(
108 typename InImageT::const_xy_locator inImageLocator,
110 int kWidth, int kHeight);
111
112template <typename OutImageT, typename InImageT>
113inline typename OutImageT::SinglePixel convolveAtAPoint(
114 typename InImageT::const_xy_locator inImageLocator,
117
188template <typename OutImageT, typename InImageT, typename KernelT>
189void convolve(OutImageT& convolvedImage, InImageT const& inImage, KernelT const& kernel,
190 ConvolutionControl const& convolutionControl = ConvolutionControl());
191
197template <typename ImageT>
200) {
201 using SinglePixelT = typename ImageT::SinglePixel;
204 : 0);
205}
206
218template <typename MaskedImageT>
219typename MaskedImageT::SinglePixel edgePixel(
222) {
223 using ImagePixelT = typename MaskedImageT::Image::Pixel;
224 using VariancePixelT = typename MaskedImageT::Variance::Pixel;
225
228 : 0;
229 auto maskPixel = MaskedImageT::Mask::getPlaneBitMask("NO_DATA");
232 : 0;
233 return typename MaskedImageT::SinglePixel(imagePixel, maskPixel, variancePixel);
234}
235
236/*
237 * Define inline functions
238 */
239
256template <typename OutImageT, typename InImageT>
257inline typename OutImageT::SinglePixel convolveAtAPoint(
258 typename InImageT::const_xy_locator inImageLocator,
259 image::Image<Kernel::Pixel>::const_xy_locator kernelLocator, int kWidth, int kHeight) {
260 typename OutImageT::SinglePixel outValue = 0;
261 for (int kRow = 0; kRow != kHeight; ++kRow) {
263 kernelLocator + image::detail::difference_type(kWidth, 0);
264 kernelLocator != kEnd; ++inImageLocator.x(), ++kernelLocator.x()) {
265 typename Kernel::Pixel const kVal = kernelLocator[0];
266 if (kVal != 0) {
267 outValue += *inImageLocator * kVal;
268 }
269 }
270
271 inImageLocator += image::detail::difference_type(-kWidth, 1);
272 kernelLocator += image::detail::difference_type(-kWidth, 1);
273 }
274
275 return outValue;
276}
277
292template <typename OutImageT, typename InImageT>
293inline typename OutImageT::SinglePixel convolveAtAPoint(typename InImageT::const_xy_locator inImageLocator,
294 std::vector<Kernel::Pixel> const& kernelXList,
295 std::vector<Kernel::Pixel> const& kernelYList) {
296 using k_iter = typename std::vector<Kernel::Pixel>::const_iterator;
297
298 using OutT = typename OutImageT::SinglePixel;
299 OutT outValue = 0;
300 for (double kValY : kernelYList) {
301 OutT outValueY = 0;
302 for (k_iter kernelXIter = kernelXList.begin(), xEnd = kernelXList.end(); kernelXIter != xEnd;
303 ++kernelXIter, ++inImageLocator.x()) {
304 typename Kernel::Pixel const kValX = *kernelXIter;
305 if (kValX != 0) {
306 outValueY += *inImageLocator * kValX;
307 }
308 }
309
310 if (kValY != 0) {
311 outValue += outValueY * kValY;
312 }
313
314 inImageLocator += image::detail::difference_type(-kernelXList.size(), 1);
315 }
316
317 return outValue;
318}
319} // namespace math
320} // namespace afw
321} // namespace lsst
322
323#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.
void setDoCopyEdge(bool doCopyEdge)
void setDoNormalize(bool doNormalize)
ConvolutionControl(bool doNormalize=true, bool doCopyEdge=false, int maxInterpolationDistance=10)
void setMaxInterpolationDistance(int maxInterpolationDistance)
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.
T quiet_NaN(T... args)
T size(T... args)
A traits class for MaskedImage.
Definition MaskedImage.h:51