Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a3f7a6a005,g07dc498a13+5ab4d22ec3,g0fba68d861+870ee37b31,g1409bbee79+5ab4d22ec3,g1a7e361dbc+5ab4d22ec3,g1fd858c14a+11200c7927,g20f46db602+25d63fd678,g35bb328faa+fcb1d3bbc8,g4d2262a081+cc8af5cafb,g4d39ba7253+6b9d64fe03,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+6b9d64fe03,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8048e755c2+a1301e4c20,g8852436030+a750987b4a,g89139ef638+5ab4d22ec3,g89e1512fd8+a86d53a4aa,g8d6b6b353c+6b9d64fe03,g9125e01d80+fcb1d3bbc8,g989de1cb63+5ab4d22ec3,g9f33ca652e+38ca901d1a,ga9baa6287d+6b9d64fe03,gaaedd4e678+5ab4d22ec3,gabe3b4be73+1e0a283bba,gb1101e3267+aa269f591c,gb58c049af0+f03b321e39,gb90eeb9370+af74afe682,gc741bbaa4f+7f5db660ea,gcf25f946ba+a750987b4a,gd315a588df+b78635c672,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+5839af1903,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,w.2025.11
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
gaussian.cc
Go to the documentation of this file.
1/*
2 * This file is part of gauss2d.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (https://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
24#include <pybind11/pybind11.h>
25#include <pybind11/operators.h>
26#include <pybind11/stl.h>
27
28#include <memory>
29#include <stdexcept>
30
31#include "pybind11.h"
32
34
35#define PYBIND11_DETAILED_ERROR_MESSAGES
36
37namespace py = pybind11;
38using namespace pybind11::literals;
39
40namespace gauss2d = lsst::gauss2d;
41
42void bind_gaussian(py::module &m) {
43 m.doc() = "Gauss2D Gaussian Python bindings";
44
45 m.attr("M_HWHM_SIGMA") = py::float_(gauss2d::M_HWHM_SIGMA);
46 m.attr("M_SIGMA_HWHM") = py::float_(gauss2d::M_SIGMA_HWHM);
47
48 auto _g = py::class_<gauss2d::GaussianIntegral, std::shared_ptr<gauss2d::GaussianIntegral>>(
49 m, "GaussianIntegral");
51 std::shared_ptr<gauss2d::GaussianIntegralValue>>(m, "GaussianIntegralValue")
52 .def(py::init<double>(), "value"_a = 1)
53 .def_property("value", &gauss2d::GaussianIntegralValue::get_value,
55 .def(py::self == py::self)
56 .def(py::self != py::self)
57 .def("__repr__",
58 [](const gauss2d::GaussianIntegralValue &self) {
59 return self.repr(true, self.PY_NAMESPACE_SEPARATOR);
60 })
62
63 py::class_<gauss2d::Gaussian, std::shared_ptr<gauss2d::Gaussian>>(m, "Gaussian")
66 "centroid"_a = nullptr, "ellipse"_a = nullptr, "integral"_a = nullptr)
67 .def_property_readonly("centroid", &gauss2d::Gaussian::get_centroid)
68 .def_property_readonly("ellipse", &gauss2d::Gaussian::get_ellipse)
69 .def_property_readonly("integral", &gauss2d::Gaussian::get_integral)
70 .def_property("const_normal", &gauss2d::Gaussian::get_const_normal,
72 .def_property("integral_value", &gauss2d::Gaussian::get_integral_value,
74 .def(py::self == py::self)
75 .def(py::self != py::self)
76 .def("__repr__",
77 [](const gauss2d::Gaussian &self) { return self.repr(true, self.PY_NAMESPACE_SEPARATOR); })
78 .def("__str__", &gauss2d::Gaussian::str);
79 py::class_<gauss2d::Gaussians, std::shared_ptr<gauss2d::Gaussians>>(m, "Gaussians")
80 .def(py::init<std::optional<const gauss2d::Gaussians::Data>>(), "gaussians"_a)
81 .def("at", &gauss2d::Gaussians::at, py::return_value_policy::copy)
82 .def_property_readonly("size", &gauss2d::Gaussians::size)
83 .def("__getitem__", &gauss2d::Gaussians::at_ptr, py::return_value_policy::copy)
84 .def("__len__", &gauss2d::Gaussians::size)
85 .def("__repr__",
86 [](const gauss2d::Gaussians &self) { return self.repr(true, self.PY_NAMESPACE_SEPARATOR); })
87 .def("__str__", &gauss2d::Gaussians::str);
88 py::class_<gauss2d::ConvolvedGaussian, std::shared_ptr<gauss2d::ConvolvedGaussian>>(m,
89 "ConvolvedGaussian")
91 "source"_a = nullptr, "kernel"_a = nullptr)
92 .def_property_readonly("kernel", &gauss2d::ConvolvedGaussian::get_kernel)
93 .def_property_readonly("source", &gauss2d::ConvolvedGaussian::get_source)
94 .def(py::self == py::self)
95 .def(py::self != py::self)
96 .def("__repr__",
97 [](const gauss2d::ConvolvedGaussian &self) {
98 return self.repr(true, self.PY_NAMESPACE_SEPARATOR);
99 })
100 .def("__str__", &gauss2d::ConvolvedGaussian::str);
101 py::class_<gauss2d::ConvolvedGaussians, std::shared_ptr<gauss2d::ConvolvedGaussians>>(
102 m, "ConvolvedGaussians")
103 .def(py::init<std::optional<const gauss2d::ConvolvedGaussians::Data>>(), "convolvedbgaussians"_a)
104 .def("at", &gauss2d::ConvolvedGaussians::at_ptr, py::return_value_policy::copy)
105 .def_property_readonly("size", &gauss2d::ConvolvedGaussians::size)
106 .def("__getitem__", &gauss2d::ConvolvedGaussians::at_ptr, py::return_value_policy::copy)
107 .def("__len__", &gauss2d::ConvolvedGaussians::size)
108 .def("__repr__",
109 [](const gauss2d::ConvolvedGaussians &self) {
110 return self.repr(true, self.PY_NAMESPACE_SEPARATOR);
111 })
112 .def("__str__", &gauss2d::ConvolvedGaussians::str);
113}
A convolution of a Gaussian source and kernel.
Definition gaussian.h:220
const Gaussian & get_source() const
Definition gaussian.cc:222
std::string str() const override
Return a brief, human-readable string representation of this.
Definition gaussian.cc:239
const Gaussian & get_kernel() const
Definition gaussian.cc:223
A collection of ConvolvedGaussian objects.
Definition gaussian.h:249
std::string str() const override
Return a brief, human-readable string representation of this.
Definition gaussian.cc:282
std::shared_ptr< ConvolvedGaussian > at_ptr(size_t i) const
Definition gaussian.cc:252
A 2D Gaussian with a Centroid, Ellipse, and integral.
Definition gaussian.h:99
Ellipse & get_ellipse()
Get the ellipse object.
Definition gaussian.cc:58
void set_const_normal(double const_normal)
Definition gaussian.cc:69
GaussianIntegral & get_integral()
Get the integral object.
Definition gaussian.cc:59
double get_integral_value() const
Get the integral value.
Definition gaussian.cc:55
void set_integral_value(double integral)
Definition gaussian.cc:72
double get_const_normal() const
Get the multiplicative factor for Gaussian function evaluations: integral/(2*area)
Definition gaussian.cc:54
Centroid & get_centroid()
Get the centroid object.
Definition gaussian.cc:57
std::string str() const override
Return a brief, human-readable string representation of this.
Definition gaussian.cc:91
Interface for the normalization (total integrated value) of a 2D Gaussian.
Definition gaussian.h:47
A GaussianIntegral storing a float value.
Definition gaussian.h:72
double get_value() const override
Definition gaussian.h:79
void set_value(double value) override
Definition gaussian.h:80
std::string str() const override
Return a brief, human-readable string representation of this.
Definition gaussian.cc:43
std::string repr(bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
Return a full, callable string representation of this.
Definition gaussian.cc:39
An array of Gaussian objects.
Definition gaussian.h:175
Gaussian & at(size_t i) const
Definition gaussian.cc:148
std::shared_ptr< Gaussian > at_ptr(size_t i) const
Definition gaussian.cc:150
size_t size() const
Definition gaussian.cc:162
std::string str() const override
Return a brief, human-readable string representation of this.
Definition gaussian.cc:171
static constexpr std::string_view PY_NAMESPACE_SEPARATOR
Definition object.h:47
const double M_SIGMA_HWHM
Definition ellipse.h:39
const double M_HWHM_SIGMA
Definition ellipse.h:38
void bind_gaussian(py::module &m)
Definition gaussian.cc:42