LSSTApplications  20.0.0
LSSTDataManagementBasePackage
imageSubtract.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  *
4  * This product includes software developed by the
5  * LSST Project (http://www.lsst.org/).
6  * See the COPYRIGHT file
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 #include "pybind11/pybind11.h"
23 #include "pybind11/eigen.h"
24 
25 #include "ndarray/pybind11.h"
26 
27 #include "lsst/afw/image/Image.h"
29 #include "lsst/afw/math/Function.h"
30 #include "lsst/afw/math/Kernel.h"
32 
33 namespace py = pybind11;
34 using namespace pybind11::literals;
35 
36 namespace lsst {
37 namespace ip {
38 namespace diffim {
39 
40 namespace {
41 
51 template <typename PixelT, typename BackgroundT>
52 void declareConvolveAndSubtract(py::module &mod) {
53  mod.def("convolveAndSubtract",
54  (afw::image::MaskedImage<PixelT>(*)(afw::image::MaskedImage<PixelT> const &,
55  afw::image::MaskedImage<PixelT> const &,
56  afw::math::Kernel const &, BackgroundT, bool)) &
58  "templateImage"_a, "scienceMaskedImage"_a, "convolutionKernel"_a, "background"_a,
59  "invert"_a = true);
60 
61  mod.def("convolveAndSubtract",
62  (afw::image::MaskedImage<PixelT>(*)(afw::image::Image<PixelT> const &,
63  afw::image::MaskedImage<PixelT> const &,
64  afw::math::Kernel const &, BackgroundT, bool)) &
66  "templateImage"_a, "scienceMaskedImage"_a, "convolutionKernel"_a, "background"_a,
67  "invert"_a = true);
68 }
69 
70 } // namespace lsst::ip::diffim::<anonymous>
71 
72 PYBIND11_MODULE(imageSubtract, mod) {
73  py::module::import("lsst.afw.image");
74  py::module::import("lsst.afw.math");
75 
76  declareConvolveAndSubtract<float, double>(mod);
77  declareConvolveAndSubtract<float, afw::math::Function2<double> const &>(mod);
78 }
79 
80 } // diffim
81 } // ip
82 } // lsst
MaskedImage.h
lsst::ip::diffim::convolveAndSubtract
lsst::afw::image::MaskedImage< PixelT > convolveAndSubtract(lsst::afw::image::MaskedImage< PixelT > const &templateImage, lsst::afw::image::MaskedImage< PixelT > const &scienceMaskedImage, lsst::afw::math::Kernel const &convolutionKernel, BackgroundT background, bool invert=true)
Execute fundamental task of convolving template and subtracting it from science image.
Definition: ImageSubtract.cc:115
Image.h
ImageSubtract.h
Image Subtraction helper functions.
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::ip::diffim::PYBIND11_MODULE
PYBIND11_MODULE(imageSubtract, mod)
Definition: imageSubtract.cc:72
Kernel.h
pybind11
Definition: _GenericMap.cc:40
Function.h
lsst::meas::modelfit.psf.psfContinued.module
module
Definition: psfContinued.py:42