LSSTApplications  20.0.0
LSSTDataManagementBasePackage
kernelCandidate.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 #include "pybind11/stl.h"
25 
26 #include "Eigen/Core"
27 #include "ndarray/pybind11.h"
28 
29 #include <memory>
30 #include <string>
31 
34 
35 namespace py = pybind11;
36 using namespace pybind11::literals;
37 
38 namespace lsst {
39 namespace ip {
40 namespace diffim {
41 
42 namespace {
43 
51 template <typename PixelT>
52 void declareKernelCandidate(py::module &mod, std::string const &suffix) {
53  py::class_<KernelCandidate<PixelT>, std::shared_ptr<KernelCandidate<PixelT>>,
54  afw::math::SpatialCellImageCandidate>
55  cls(mod, ("KernelCandidate" + suffix).c_str());
56 
57  using CandidateSwitch = typename KernelCandidate<PixelT>::CandidateSwitch;
58 
59  py::enum_<CandidateSwitch>(cls, "CandidateSwitch")
60  .value("ORIG", CandidateSwitch::ORIG)
61  .value("PCA", CandidateSwitch::PCA)
62  .value("RECENT", CandidateSwitch::RECENT)
63  .export_values();
64 
65  cls.def(py::init<float const, float const, std::shared_ptr<afw::image::MaskedImage<PixelT>> const &,
66  std::shared_ptr<afw::image::MaskedImage<PixelT>> const &, daf::base::PropertySet const &>(),
67  "xCenter"_a, "yCenter"_a, "templateMaskedImage"_a, "scienceMaskedImage"_a, "ps"_a);
69  std::shared_ptr<afw::image::MaskedImage<PixelT>> const &,
70  std::shared_ptr<afw::image::MaskedImage<PixelT>> const &, daf::base::PropertySet const &>(),
71  "source"_a, "templateMaskedImage"_a, "scienceMaskedImage"_a, "ps"_a);
72 
73  cls.def("getCandidateRating", &KernelCandidate<PixelT>::getCandidateRating);
74  cls.def("getSource", &KernelCandidate<PixelT>::getSource);
75  cls.def("getTemplateMaskedImage", &KernelCandidate<PixelT>::getTemplateMaskedImage);
76  cls.def("getScienceMaskedImage", &KernelCandidate<PixelT>::getScienceMaskedImage);
77  cls.def("getKernel", &KernelCandidate<PixelT>::getKernel, "cand"_a);
78  cls.def("getBackground", &KernelCandidate<PixelT>::getBackground, "cand"_a);
79  cls.def("getKsum", &KernelCandidate<PixelT>::getKsum, "cand"_a);
80  cls.def("getKernelImage", &KernelCandidate<PixelT>::getKernelImage, "cand"_a);
81  cls.def("getImage", &KernelCandidate<PixelT>::getImage);
82  cls.def("getKernelSolution", &KernelCandidate<PixelT>::getKernelSolution, "cand"_a);
83  cls.def("getDifferenceImage",
84  (afw::image::MaskedImage<PixelT> (KernelCandidate<PixelT>::*)(CandidateSwitch)) &
85  KernelCandidate<PixelT>::getDifferenceImage,
86  "cand"_a);
87  cls.def("getDifferenceImage", (afw::image::MaskedImage<PixelT> (KernelCandidate<PixelT>::*)(
89  KernelCandidate<PixelT>::getDifferenceImage,
90  "kernel"_a, "background"_a);
91  cls.def("isInitialized", &KernelCandidate<PixelT>::isInitialized);
92  cls.def("build", (void (KernelCandidate<PixelT>::*)(afw::math::KernelList const &)) &
93  KernelCandidate<PixelT>::build,
94  "basisList"_a);
95  cls.def("build",
96  (void (KernelCandidate<PixelT>::*)(afw::math::KernelList const &, Eigen::MatrixXd const &)) &
97  KernelCandidate<PixelT>::build,
98  "basisList"_a, "hMat"_a);
99  mod.def("makeKernelCandidate",
100  (std::shared_ptr<KernelCandidate<PixelT>>(*)(
101  float const, float const, std::shared_ptr<afw::image::MaskedImage<PixelT>> const &,
102  std::shared_ptr<afw::image::MaskedImage<PixelT>> const &, daf::base::PropertySet const &)) &
104  "xCenter"_a, "yCenter"_a, "templateMaskedImage"_a, "scienceMaskedImage"_a, "ps"_a);
105  mod.def("makeKernelCandidate",
106  (std::shared_ptr<KernelCandidate<PixelT>>(*)(
108  std::shared_ptr<afw::image::MaskedImage<PixelT>> const &,
109  std::shared_ptr<afw::image::MaskedImage<PixelT>> const &, daf::base::PropertySet const &)) &
111  "source"_a, "templateMaskedImage"_a, "scienceMaskedImage"_a, "ps"_a);
112 }
113 
114 } // namespace lsst::ip::diffim::<anonymous>
115 
116 PYBIND11_MODULE(kernelCandidate, mod) {
117  py::module::import("lsst.afw.image");
118  py::module::import("lsst.afw.math");
119  py::module::import("lsst.afw.table");
120  py::module::import("lsst.daf.base");
121 
122  declareKernelCandidate<float>(mod, "F");
123 }
124 
125 } // diffim
126 } // ip
127 } // lsst
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
SpatialCell.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::math::KernelList
std::vector< std::shared_ptr< Kernel > > KernelList
Definition: Kernel.h:509
KernelCandidate.h
Class used by SpatialModelCell for spatial Kernel fitting.
lsst::ip::diffim::PYBIND11_MODULE
PYBIND11_MODULE(kernelCandidate, mod)
Definition: kernelCandidate.cc:116
pybind11
Definition: _GenericMap.cc:40
lsst::utils.tests.init
def init()
Definition: tests.py:58
lsst::meas::modelfit.psf.psfContinued.module
module
Definition: psfContinued.py:42
lsst::ip::diffim::makeKernelCandidate
std::shared_ptr< KernelCandidate< PixelT > > makeKernelCandidate(float const xCenter, float const yCenter, std::shared_ptr< afw::image::MaskedImage< PixelT > > const &templateMaskedImage, std::shared_ptr< afw::image::MaskedImage< PixelT > > const &scienceMaskedImage, daf::base::PropertySet const &ps)
Return a KernelCandidate pointer of the right sort.
Definition: KernelCandidate.h:220