LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
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)
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
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