LSST Applications g04a91732dc+cc8870d3f5,g07dc498a13+5aa0b8792f,g0fba68d861+488cddfaa9,g1409bbee79+5aa0b8792f,g1a7e361dbc+5aa0b8792f,g1fd858c14a+f64bc332a9,g35bb328faa+fcb1d3bbc8,g4d2262a081+b1c1982739,g4d39ba7253+9633a327c1,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9633a327c1,g668ecb457e+25d63fd678,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+8b64ca622a,g89139ef638+5aa0b8792f,g89e1512fd8+37f975783e,g8d6b6b353c+9633a327c1,g9125e01d80+fcb1d3bbc8,g989de1cb63+5aa0b8792f,g9f33ca652e+b196626af7,ga9baa6287d+9633a327c1,gaaedd4e678+5aa0b8792f,gabe3b4be73+1e0a283bba,gb1101e3267+71e32094df,gb58c049af0+f03b321e39,gb90eeb9370+2807b1ad02,gc741bbaa4f+1ae86710ed,gcf25f946ba+8b64ca622a,gd315a588df+a39986a76f,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+94dfc458f4,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gfe73954cf8+a1301e4c20,w.2025.11
LSST Data Management Base Package
|
An EllipseData storing sigma_x, sigma_y, rho values as shared_ptrs. More...
#include <ellipse.h>
Public Member Functions | |
EllipseValues (std::shared_ptr< double > sigma_x, std::shared_ptr< double > sigma_y, std::shared_ptr< double > rho=nullptr) | |
Construct a new EllipseValues object. | |
EllipseValues (double sigma_x=0, double sigma_y=0, double rho=0) | |
Construct a new EllipseValues object, creating new pointers for every value. | |
double | get_sigma_x () const override |
Get sigma_x. | |
double | get_sigma_y () const override |
Get sigma_y. | |
double | get_rho () const override |
Get rho. | |
std::array< double, 3 > | get_xyr () const override |
Get sigma_x, sigma_y, rho. | |
void | set (double sigma_x, double sigma_y, double rho) override |
Set sigma_x, sigma_y, rho. | |
void | set_h (double hwhm_x, double hwhm_y, double rho) override |
Set hwhm_x, hwhm_y, rho (half-width at half-max) | |
void | set_sigma_x (double sigma_x) override |
Set the x-axis dispersion (sigma) | |
void | set_sigma_y (double sigma_y) override |
Set the y-axis dispersion (sigma) | |
void | set_rho (double rho) override |
Set the correlation parameter (rho) | |
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. | |
virtual void | convolve (const Ellipse &ell) |
Convolve this ellipse with another. | |
virtual double | get_area () const |
Return the area of this ellipse, equal to pi*sigma_major*sigma_minor. | |
virtual double | get_cov_xy () const |
Return the covariance, equal to sigma_x*sigma_y*rho. | |
virtual double | get_hwhm_x () const |
Get the x-axis half-width at half-maximum. | |
virtual double | get_hwhm_y () const |
Get the y-axis half-width at half-maximum. | |
virtual double | get_radius_trace () const |
Return the trace radius, equal to sqrt(sigma_x^2 + sigma_y^2) | |
virtual double | get_sigma_x_sq () const |
Get the square of sigma_x. | |
virtual double | get_sigma_y_sq () const |
Get the square of sigma_y. | |
virtual double | get_sigma_xy () const |
Return sigma_x*sigma_y. | |
virtual std::array< double, 3 > | get_hxyr () const |
Get hwhm_x, hwhm_y, rho. | |
virtual void | set (const Covariance &covar) |
Set values from a Covariance object. | |
virtual void | set (const EllipseMajor &ellipse) |
Set values from an EllipseMajor object. | |
virtual void | set_hwhm_x (double hwhm_x) |
Set the x-axis half-width at half-max (FWHM/2) | |
virtual void | set_hwhm_y (double hwhm_y) |
Set the y-axis half-width at half-max (FWHM/2) | |
virtual void | set_hxyr (const std::array< double, 3 > &hxyr) |
Set hwhm_x, hwhm_y, rho from an array. | |
virtual void | set_xyr (const std::array< double, 3 > &xyr) |
Set sigma_x, sigma_y, rho from an array. | |
bool | operator== (const EllipseData &other) const |
bool | operator!= (const EllipseData &other) const |
Static Public Member Functions | |
static void | check (double size_x, double size_y, double rho, std::string_view error_suffix="") |
Check whether Ellipse parameter values are valid, throwing if not. | |
static void | check_size (double size, std::string_view error_suffix="") |
Check whether an x- or x-yaxis size value is valid. | |
static void | check_rho (double rho, std::string_view error_suffix="") |
Check whether a rho value is valid. | |
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 = "." |
An EllipseData storing sigma_x, sigma_y, rho values as shared_ptrs.
This implementation stores values in shared_ptrs, allowing sharing of values with other instances.
|
inlineexplicit |
Construct a new EllipseValues object.
sigma_x | The sigma_x shared_ptr |
sigma_y | The sigma_y shared_ptr |
rho | The rho shared_ptr, defaulting to a new zero-valued double |
Definition at line 241 of file ellipse.h.
|
inlineexplicit |
Construct a new EllipseValues object, creating new pointers for every value.
Definition at line 247 of file ellipse.h.
|
inlinestaticinherited |
Check whether Ellipse parameter values are valid, throwing if not.
Definition at line 137 of file ellipse.h.
|
inlinestaticinherited |
Check whether a rho value is valid.
Definition at line 153 of file ellipse.h.
|
inlinestaticinherited |
|
virtualinherited |
Convolve this ellipse with another.
Definition at line 149 of file ellipse.cc.
|
virtualinherited |
Return the area of this ellipse, equal to pi*sigma_major*sigma_minor.
Definition at line 142 of file ellipse.cc.
|
virtualinherited |
|
virtualinherited |
Get the x-axis half-width at half-maximum.
Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse.
Definition at line 162 of file ellipse.cc.
|
virtualinherited |
Get the y-axis half-width at half-maximum.
Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse.
Definition at line 164 of file ellipse.cc.
|
virtualinherited |
Get hwhm_x, hwhm_y, rho.
Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse.
Definition at line 166 of file ellipse.cc.
|
virtualinherited |
Return the trace radius, equal to sqrt(sigma_x^2 + sigma_y^2)
Definition at line 173 of file ellipse.cc.
|
overridevirtual |
Get rho.
Implements lsst::gauss2d::EllipseData.
Definition at line 187 of file ellipse.cc.
|
overridevirtual |
Get sigma_x.
Implements lsst::gauss2d::EllipseData.
Definition at line 185 of file ellipse.cc.
|
virtualinherited |
Get the square of sigma_x.
Definition at line 175 of file ellipse.cc.
|
virtualinherited |
|
overridevirtual |
Get sigma_y.
Implements lsst::gauss2d::EllipseData.
Definition at line 186 of file ellipse.cc.
|
virtualinherited |
Get the square of sigma_y.
Definition at line 180 of file ellipse.cc.
|
overridevirtual |
Get sigma_x, sigma_y, rho.
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 188 of file ellipse.cc.
|
inlinestaticinherited |
Definition at line 49 of file object.h.
|
inlineinherited |
|
inlineinherited |
Definition at line 216 of file ellipse.h.
|
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::EllipseData.
Definition at line 219 of file ellipse.cc.
|
virtualinherited |
Set values from a Covariance object.
Definition at line 263 of file ellipse.cc.
|
virtualinherited |
Set values from an EllipseMajor object.
Definition at line 272 of file ellipse.cc.
|
overridevirtual |
Set sigma_x, sigma_y, rho.
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 205 of file ellipse.cc.
|
overridevirtual |
Set hwhm_x, hwhm_y, rho (half-width at half-max)
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 212 of file ellipse.cc.
|
virtualinherited |
Set the x-axis half-width at half-max (FWHM/2)
Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse.
Definition at line 303 of file ellipse.cc.
|
virtualinherited |
Set the y-axis half-width at half-max (FWHM/2)
Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse.
Definition at line 304 of file ellipse.cc.
|
virtualinherited |
Set hwhm_x, hwhm_y, rho from an array.
Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse, and lsst::gauss2d::fit::SersicEllipseData.
Definition at line 305 of file ellipse.cc.
|
overridevirtual |
Set the correlation parameter (rho)
Implements lsst::gauss2d::EllipseData.
Definition at line 200 of file ellipse.cc.
|
overridevirtual |
Set the x-axis dispersion (sigma)
Implements lsst::gauss2d::EllipseData.
Definition at line 190 of file ellipse.cc.
|
overridevirtual |
Set the y-axis dispersion (sigma)
Implements lsst::gauss2d::EllipseData.
Definition at line 195 of file ellipse.cc.
|
virtualinherited |
Set sigma_x, sigma_y, rho from an array.
Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse, and lsst::gauss2d::fit::SersicEllipseData.
Definition at line 306 of file ellipse.cc.
|
overridevirtual |
Return a brief, human-readable string representation of this.
Implements lsst::gauss2d::EllipseData.
Definition at line 226 of file ellipse.cc.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |