lsst.ip.diffim  13.0-22-g3839dbb+8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 
24 #include "Eigen/Core"
25 #include "numpy/arrayobject.h"
26 #include "ndarray/pybind11.h"
27 
28 #include "lsst/afw/image/Image.h"
29 #include "lsst/afw/image/MaskedImage.h"
30 #include "lsst/afw/math/Function.h"
31 #include "lsst/afw/math/Kernel.h"
33 
34 namespace py = pybind11;
35 using namespace pybind11::literals;
36 
37 namespace lsst {
38 namespace ip {
39 namespace diffim {
40 
41 namespace {
42 
52 template <typename PixelT, typename BackgroundT>
53 void declareConvolveAndSubtract(py::module &mod) {
54  mod.def("convolveAndSubtract",
55  (afw::image::MaskedImage<PixelT>(*)(afw::image::MaskedImage<PixelT> const &,
56  afw::image::MaskedImage<PixelT> const &,
57  afw::math::Kernel const &, BackgroundT, bool)) &
59  "templateImage"_a, "scienceMaskedImage"_a, "convolutionKernel"_a, "background"_a,
60  "invert"_a = true);
61 
62  mod.def("convolveAndSubtract",
63  (afw::image::MaskedImage<PixelT>(*)(afw::image::Image<PixelT> const &,
64  afw::image::MaskedImage<PixelT> const &,
65  afw::math::Kernel const &, BackgroundT, bool)) &
66  convolveAndSubtract,
67  "templateImage"_a, "scienceMaskedImage"_a, "convolutionKernel"_a, "background"_a,
68  "invert"_a = true);
69 }
70 
71 } // namespace lsst::ip::diffim::<anonymous>
72 
73 PYBIND11_PLUGIN(imageSubtract) {
74  py::module::import("lsst.afw.image");
75  py::module::import("lsst.afw.math");
76 
77  py::module mod("imageSubtract");
78 
79  // Need to import numpy for ndarray and eigen conversions
80  if (_import_array() < 0) {
81  PyErr_SetString(PyExc_ImportError, "numpy.core.multiarray failed to import");
82  return nullptr;
83  }
84 
85  declareConvolveAndSubtract<float, double>(mod);
86  declareConvolveAndSubtract<float, afw::math::Function2<double> const &>(mod);
87 
88  return mod.ptr();
89 }
90 
91 } // diffim
92 } // ip
93 } // lsst
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.
PYBIND11_PLUGIN(basisLists)
Definition: basisLists.cc:39
Image Subtraction helper functions.