LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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 &)) &
110  makeKernelCandidate,
111  "source"_a, "templateMaskedImage"_a, "scienceMaskedImage"_a, "ps"_a);
112 }
113 
114 } // namespace lsst::ip::diffim::<anonymous>
115 
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
def init()
Definition: tests.py:64
PYBIND11_MODULE(kernelCandidate, mod)
STL class.
A base class for image defects.
Class used by SpatialModelCell for spatial Kernel fitting.
std::vector< std::shared_ptr< Kernel > > KernelList
Definition: Kernel.h:497