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
|
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 |