LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
_kernel.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2016 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
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 
23 #include <pybind11/pybind11.h>
24 #include <lsst/utils/python.h>
25 
26 #include <pybind11/stl.h>
27 
28 #include "lsst/afw/math/Kernel.h"
29 #include "lsst/afw/table/io/python.h" // for addPersistableMethods
30 
31 namespace py = pybind11;
32 
33 using namespace py::literals;
34 
35 using namespace lsst::afw::math;
36 namespace lsst {
37 namespace afw {
38 namespace math {
40  using PyKernel = py::class_<Kernel, std::shared_ptr<Kernel>>;
41 
42  wrappers.addSignatureDependency("lsst.afw.table");
43  wrappers.addSignatureDependency("lsst.afw.table.io");
44 
45  wrappers.wrapType(PyKernel(wrappers.module, "Kernel"), [](auto &mod, auto &cls) {
46  lsst::afw::table::io::python::addPersistableMethods<Kernel>(cls);
47 
48  cls.def("clone", &Kernel::clone);
49  cls.def("resized", &Kernel::resized, "width"_a, "height"_a);
50  cls.def("computeImage", &Kernel::computeImage, "image"_a, "doNormalize"_a, "x"_a = 0.0, "y"_a = 0.0);
51  cls.def("getDimensions", &Kernel::getDimensions);
52  cls.def("setDimensions", &Kernel::setDimensions);
53  cls.def("setWidth", &Kernel::setWidth);
54  cls.def("setHeight", &Kernel::setHeight);
55  cls.def("getWidth", &Kernel::getWidth);
56  cls.def("getHeight", &Kernel::getHeight);
57  cls.def("getCtr", &Kernel::getCtr);
58  cls.def("getBBox", &Kernel::getBBox);
59  cls.def("getNKernelParameters", &Kernel::getNKernelParameters);
60  cls.def("getNSpatialParameters", &Kernel::getNSpatialParameters);
61  cls.def("getSpatialFunction", &Kernel::getSpatialFunction);
62  cls.def("getSpatialFunctionList", &Kernel::getSpatialFunctionList);
63  cls.def("getKernelParameter", &Kernel::getKernelParameter);
64  cls.def("getKernelParameters", &Kernel::getKernelParameters);
65  cls.def("growBBox", &Kernel::growBBox);
66  cls.def("shrinkBBox", &Kernel::shrinkBBox);
67  cls.def("setCtr", &Kernel::setCtr);
68  cls.def("getSpatialParameters", &Kernel::getSpatialParameters);
69  cls.def("isSpatiallyVarying", &Kernel::isSpatiallyVarying);
70  cls.def("setKernelParameters",
71  (void (Kernel::*)(std::vector<double> const &)) & Kernel::setKernelParameters);
72  cls.def("setKernelParameters",
73  (void (Kernel::*)(std::pair<double, double> const &)) & Kernel::setKernelParameters);
74  cls.def("setSpatialParameters", &Kernel::setSpatialParameters);
75  cls.def("computeKernelParametersFromSpatialModel", &Kernel::computeKernelParametersFromSpatialModel);
76  cls.def("toString", &Kernel::toString, "prefix"_a = "");
77  cls.def("computeCache", &Kernel::computeCache);
78  cls.def("getCacheSize", &Kernel::getCacheSize);
79  });
80 
81  using PyFixedKernel = py::class_<FixedKernel, std::shared_ptr<FixedKernel>, Kernel>;
82  wrappers.wrapType(PyFixedKernel(wrappers.module, "FixedKernel"), [](auto &mod, auto &cls) {
83  cls.def(py::init<>());
84  cls.def(py::init<lsst::afw::image::Image<Kernel::Pixel> const &>(), "image"_a);
85  cls.def(py::init<lsst::afw::math::Kernel const &, lsst::geom::Point2D const &>(), "kernel"_a,
86  "pos"_a);
87  cls.def("clone", &FixedKernel::clone);
88  cls.def("resized", &FixedKernel::resized, "width"_a, "height"_a);
89  cls.def("toString", &FixedKernel::toString, "prefix"_a = "");
90  cls.def("getSum", &FixedKernel::getSum);
91  cls.def("isPersistable", &FixedKernel::isPersistable);
92  });
93 
94  using PyAnalyticKernel = py::class_<AnalyticKernel, std::shared_ptr<AnalyticKernel>, Kernel>;
95  wrappers.wrapType(PyAnalyticKernel(wrappers.module, "AnalyticKernel"), [](auto &mod, auto &cls) {
96  cls.def(py::init<>());
97  // Workaround for NullSpatialFunction and py::arg not playing well with Citizen (TODO: no longer
98  // needed?)
99  cls.def(py::init<int, int, AnalyticKernel::KernelFunction const &>(), "width"_a, "height"_a,
100  "kernelFunction"_a);
101  cls.def(py::init<int, int, AnalyticKernel::KernelFunction const &, Kernel::SpatialFunction const &>(),
102  "width"_a, "height"_a, "kernelFunction"_a, "spatialFunction"_a);
103  cls.def(py::init<int, int, AnalyticKernel::KernelFunction const &,
104  std::vector<Kernel::SpatialFunctionPtr> const &>(),
105  "width"_a, "height"_a, "kernelFunction"_a, "spatialFunctionList"_a);
106  cls.def("clone", &AnalyticKernel::clone);
107  cls.def("resized", &AnalyticKernel::resized, "width"_a, "height"_a);
108  cls.def("computeImage", &AnalyticKernel::computeImage, "image"_a, "doNormalize"_a, "x"_a = 0.0,
109  "y"_a = 0.0);
110  cls.def("getKernelParameters", &AnalyticKernel::getKernelParameters);
111  cls.def("getKernelFunction", &AnalyticKernel::getKernelFunction);
112  cls.def("toString", &AnalyticKernel::toString, "prefix"_a = "");
113  cls.def("isPersistable", &AnalyticKernel::isPersistable);
114  });
115 
116  using PyDeltaFunctionKernel =
117  py::class_<DeltaFunctionKernel, std::shared_ptr<DeltaFunctionKernel>, Kernel>;
118  wrappers.wrapType(
119  PyDeltaFunctionKernel(wrappers.module, "DeltaFunctionKernel"), [](auto &mod, auto &cls) {
120  cls.def(py::init<int, int, lsst::geom::Point2I const &>(), "width"_a, "height"_a, "point"_a);
121  cls.def("clone", &DeltaFunctionKernel::clone);
122  cls.def("resized", &DeltaFunctionKernel::resized, "width"_a, "height"_a);
123  cls.def("getPixel", &DeltaFunctionKernel::getPixel);
124  cls.def("toString", &DeltaFunctionKernel::toString, "prefix"_a = "");
125  cls.def("isPersistable", &DeltaFunctionKernel::isPersistable);
126  });
127 
128  using PyLinearCombinationKernel =
129  py::class_<LinearCombinationKernel, std::shared_ptr<LinearCombinationKernel>, Kernel>;
130  wrappers.wrapType(
131  PyLinearCombinationKernel(wrappers.module, "LinearCombinationKernel"), [](auto &mod, auto &cls) {
132  cls.def(py::init<>());
133  cls.def(py::init<KernelList const &, std::vector<double> const &>(), "kernelList"_a,
134  "kernelParameters"_a);
135  cls.def(py::init<KernelList const &, Kernel::SpatialFunction const &>(), "kernelList"_a,
136  "spatialFunction"_a);
137  cls.def(py::init<KernelList const &, std::vector<Kernel::SpatialFunctionPtr> const &>(),
138  "kernelList"_a, "spatialFunctionList"_a);
139  cls.def("clone", &LinearCombinationKernel::clone);
140  cls.def("resized", &LinearCombinationKernel::resized, "width"_a, "height"_a);
141  cls.def("getKernelParameters", &LinearCombinationKernel::getKernelParameters);
142  cls.def("getKernelList", &LinearCombinationKernel::getKernelList);
143  cls.def("getKernelSumList", &LinearCombinationKernel::getKernelSumList);
144  cls.def("getNBasisKernels", &LinearCombinationKernel::getNBasisKernels);
145  cls.def("checkKernelList", &LinearCombinationKernel::checkKernelList);
146  cls.def("isDeltaFunctionBasis", &LinearCombinationKernel::isDeltaFunctionBasis);
147  cls.def("refactor", &LinearCombinationKernel::refactor);
148  cls.def("toString", &LinearCombinationKernel::toString, "prefix"_a = "");
149  cls.def("isPersistable", &LinearCombinationKernel::isPersistable);
150  });
151 
152  using PySeparableKernel = py::class_<SeparableKernel, std::shared_ptr<SeparableKernel>, Kernel>;
153  wrappers.wrapType(PySeparableKernel(wrappers.module, "SeparableKernel"), [](auto &mod, auto &cls) {
154  cls.def(py::init<>());
155  // Workaround for NullSpatialFunction and py::arg not playing well with Citizen (TODO: no longer
156  // needed?)
157  cls.def(py::init<int, int, SeparableKernel::KernelFunction const &,
158  SeparableKernel::KernelFunction const &>(),
159  "width"_a, "height"_a, "kernelColFunction"_a, "kernelRowFunction"_a);
160  cls.def(py::init<int, int, SeparableKernel::KernelFunction const &,
161  SeparableKernel::KernelFunction const &, Kernel::SpatialFunction const &>(),
162  "width"_a, "height"_a, "kernelColFunction"_a, "kernelRowFunction"_a, "spatialFunction"_a);
163  cls.def(py::init<int, int, SeparableKernel::KernelFunction const &,
164  SeparableKernel::KernelFunction const &,
165  std::vector<Kernel::SpatialFunctionPtr> const &>(),
166  "width"_a, "height"_a, "kernelColFunction"_a, "kernelRowFunction"_a, "spatialFunctionList"_a);
167  cls.def("clone", &SeparableKernel::clone);
168  cls.def("resized", &SeparableKernel::resized, "width"_a, "height"_a);
169  cls.def("computeVectors", &SeparableKernel::computeVectors);
170  cls.def("getKernelParameter", &SeparableKernel::getKernelParameter);
171  cls.def("getKernelParameters", &SeparableKernel::getKernelParameters);
172  cls.def("getKernelColFunction", &SeparableKernel::getKernelColFunction);
173  cls.def("getKernelRowFunction", &SeparableKernel::getKernelRowFunction);
174  cls.def("toString", &SeparableKernel::toString, "prefix"_a = "");
175  cls.def("computeCache", &SeparableKernel::computeCache);
176  cls.def("getCacheSize", &SeparableKernel::getCacheSize);
177  });
178 }
179 } // namespace math
180 } // namespace afw
181 } // namespace lsst
Kernels are used for convolution with MaskedImages and (eventually) Images.
Definition: Kernel.h:111
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition: python.h:242
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition: python.h:448
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition: python.h:391
void addSignatureDependency(std::string const &name)
Indicate an external module that provides a type used in function/method signatures.
Definition: python.h:357
void wrapKernel(lsst::utils::python::WrapperCollection &wrappers)
Definition: _kernel.cc:39
A base class for image defects.