LSST Applications g0d97872fb5+4fd969bb9d,g1653933729+34a971ddd9,g28da252d5a+072f89fe25,g2bbee38e9b+a99b0ab4cd,g2bc492864f+a99b0ab4cd,g2ca4be77d2+c0e3b27cd8,g2cdde0e794+704103fe75,g3156d2b45e+6e87dc994a,g347aa1857d+a99b0ab4cd,g35bb328faa+34a971ddd9,g3a166c0a6a+a99b0ab4cd,g3e281a1b8c+8ec26ec694,g4005a62e65+ba0306790b,g414038480c+9ed5ed841a,g569e0e2b34+cb4faa46ad,g5a97de2502+520531a62c,g717e5f8c0f+29153700a5,g7ede599f99+367733290c,g80478fca09+17051a22cc,g82479be7b0+f2f1ea0a87,g858d7b2824+29153700a5,g8b782ad322+29153700a5,g8cd86fa7b1+05420e7f7d,g9125e01d80+34a971ddd9,ga5288a1d22+e7f674aaf3,gae0086650b+34a971ddd9,gae74b0b5c6+45ef5cdc51,gb58c049af0+ace264a4f2,gc28159a63d+a99b0ab4cd,gcf0d15dbbd+8051a81198,gda6a2b7d83+8051a81198,gdaeeff99f8+7774323b41,gdf4d240d4a+34a971ddd9,ge2409df99d+cb167bac99,ge33fd446bb+29153700a5,ge79ae78c31+a99b0ab4cd,gf0baf85859+890af219f9,gf5289d68f6+9faa5c5784,w.2024.36
LSST Data Management Base Package
|
A 2D Gaussian with a Centroid, Ellipse, and integral. More...
#include <gaussian.h>
Public Member Functions | |
Gaussian (std::shared_ptr< Centroid > centroid=nullptr, std::shared_ptr< Ellipse > ellipse=nullptr, std::shared_ptr< GaussianIntegral > integral=nullptr) | |
Construct a new Gaussian object. | |
~Gaussian () | |
double | get_const_normal () const |
Get the multiplicative factor for Gaussian function evaluations: integral/(2*area) | |
double | get_integral_value () const |
Get the integral value. | |
Centroid & | get_centroid () |
Get the centroid object. | |
Ellipse & | get_ellipse () |
Get the ellipse object. | |
GaussianIntegral & | get_integral () |
Get the integral object. | |
std::shared_ptr< Centroid > | get_centroid_ptr () |
std::shared_ptr< Ellipse > | get_ellipse_ptr () |
std::shared_ptr< GaussianIntegral > | get_integral_ptr () |
const Centroid & | get_centroid_const () const |
const Ellipse & | get_ellipse_const () const |
const GaussianIntegral & | get_integral_const () const |
void | set_const_normal (double const_normal) |
void | set_integral_value (double integral) |
void | set_centroid_ptr (std::shared_ptr< Centroid > centroid) |
void | set_ellipse_ptr (std::shared_ptr< Ellipse > ellipse) |
void | set_integral_ptr (std::shared_ptr< GaussianIntegral > integral) |
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. | |
std::string | str () const override |
Return a brief, human-readable string representation of this. | |
bool | operator== (const Gaussian &other) const |
bool | operator!= (const Gaussian &other) const |
Static Public Member Functions | |
static std::string_view | null_str (const std::string_view &namespace_separator) |
Static Public Attributes | |
static constexpr std::string_view | CC_NAMESPACE_SEPARATOR = "::" |
The C++ namespace separator. | |
static constexpr std::string_view | NULL_STR_GENERAL = "None" |
static constexpr std::string_view | PY_NAMESPACE_SEPARATOR = "." |
A 2D Gaussian with a Centroid, Ellipse, and integral.
Gaussian offers some convenience functions but is otherwise a container for its three component subclasses.
Definition at line 99 of file gaussian.h.
|
explicit |
Construct a new Gaussian object.
centroid | The centroid. Defaults to a new, default Centroid. |
ellipse | The ellipse. Defaults to a new, default Ellipse. |
integral | The integral. Defaults to a new, default GaussianIntegralValue. |
Definition at line 47 of file gaussian.cc.
lsst::gauss2d::Gaussian::~Gaussian | ( | ) |
Definition at line 52 of file gaussian.cc.
Centroid & lsst::gauss2d::Gaussian::get_centroid | ( | ) |
const Centroid & lsst::gauss2d::Gaussian::get_centroid_const | ( | ) | const |
Definition at line 65 of file gaussian.cc.
std::shared_ptr< Centroid > lsst::gauss2d::Gaussian::get_centroid_ptr | ( | ) |
Definition at line 61 of file gaussian.cc.
double lsst::gauss2d::Gaussian::get_const_normal | ( | ) | const |
Get the multiplicative factor for Gaussian function evaluations: integral/(2*area)
Definition at line 54 of file gaussian.cc.
Ellipse & lsst::gauss2d::Gaussian::get_ellipse | ( | ) |
const Ellipse & lsst::gauss2d::Gaussian::get_ellipse_const | ( | ) | const |
Definition at line 66 of file gaussian.cc.
std::shared_ptr< Ellipse > lsst::gauss2d::Gaussian::get_ellipse_ptr | ( | ) |
Definition at line 62 of file gaussian.cc.
GaussianIntegral & lsst::gauss2d::Gaussian::get_integral | ( | ) |
const GaussianIntegral & lsst::gauss2d::Gaussian::get_integral_const | ( | ) | const |
Definition at line 67 of file gaussian.cc.
std::shared_ptr< GaussianIntegral > lsst::gauss2d::Gaussian::get_integral_ptr | ( | ) |
Definition at line 63 of file gaussian.cc.
double lsst::gauss2d::Gaussian::get_integral_value | ( | ) | const |
Get the integral value.
Definition at line 55 of file gaussian.cc.
|
inlinestaticinherited |
Definition at line 49 of file object.h.
bool lsst::gauss2d::Gaussian::operator!= | ( | const Gaussian & | other | ) | const |
Definition at line 101 of file gaussian.cc.
bool lsst::gauss2d::Gaussian::operator== | ( | const Gaussian & | other | ) | const |
Definition at line 96 of file gaussian.cc.
|
overridevirtual |
Return a full, callable string representation of this.
name_keywords | Whether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python). |
namespace_separator | The string to use to delimit namespaces, i.e. :: in C++ and . in Python. |
Implements lsst::gauss2d::Object.
Definition at line 84 of file gaussian.cc.
void lsst::gauss2d::Gaussian::set_centroid_ptr | ( | std::shared_ptr< Centroid > | centroid | ) |
Definition at line 74 of file gaussian.cc.
void lsst::gauss2d::Gaussian::set_const_normal | ( | double | const_normal | ) |
Definition at line 69 of file gaussian.cc.
void lsst::gauss2d::Gaussian::set_ellipse_ptr | ( | std::shared_ptr< Ellipse > | ellipse | ) |
Definition at line 77 of file gaussian.cc.
void lsst::gauss2d::Gaussian::set_integral_ptr | ( | std::shared_ptr< GaussianIntegral > | integral | ) |
Definition at line 80 of file gaussian.cc.
void lsst::gauss2d::Gaussian::set_integral_value | ( | double | integral | ) |
Definition at line 72 of file gaussian.cc.
|
overridevirtual |
Return a brief, human-readable string representation of this.
Implements lsst::gauss2d::Object.
Definition at line 91 of file gaussian.cc.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |