LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
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 |