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
|
An Ellipse with sigma_x, sigma_y, and rho values. More...
#include <ellipse.h>
Public Member Functions | |
Ellipse (std::shared_ptr< EllipseData > data) | |
Ellipse (double sigma_x=0, double sigma_y=0, double rho=0) | |
Construct a new Ellipse object with default float values. | |
Ellipse (const Covariance &covar) | |
Ellipse (const EllipseMajor &ellipse) | |
const EllipseData & | get_data () const |
Return a const ref to this ellipse's data. | |
double | get_rho () const override |
Get rho. | |
double | get_sigma_x () const override |
Get sigma_x. | |
double | get_sigma_y () const override |
Get sigma_y. | |
std::shared_ptr< Ellipse > | make_convolution (const Ellipse &ell) const |
Return the convolution of this with another ellipse. | |
std::unique_ptr< Ellipse > | make_convolution_uniq (const Ellipse &ell) const |
Same as make_convolution(), but returning a unique_ptr. | |
void | set_rho (double rho) override |
Set the correlation parameter (rho) | |
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) | |
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 Ellipse &other) const |
bool | operator!= (const Ellipse &other) const |
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 std::array< double, 3 > | get_xyr () const |
Get sigma_x, sigma_y, rho. | |
virtual void | set (double sigma_x, double sigma_y, double rho) |
Set sigma_x, sigma_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_h (double hwhm_x, double hwhm_y, double rho) |
Set hwhm_x, hwhm_y, rho (half-width at half-max) | |
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 Ellipse with sigma_x, sigma_y, and rho values.
This ellipse parameterization requires sigma_x and sigma_y >=0, and the correlation -1 < rho < 1.
|
explicit |
Definition at line 232 of file ellipse.cc.
|
explicit |
Construct a new Ellipse object with default float values.
sigma_x | The initial sigma_x value (default 0) |
sigma_y | The initial sigma_y value (default 0) |
rho | The intial rho value (default 0) |
Definition at line 235 of file ellipse.cc.
|
explicit |
Definition at line 239 of file ellipse.cc.
|
explicit |
Definition at line 241 of file ellipse.cc.
|
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 |
Check whether an x- or x-yaxis size value is valid.
|
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 |
const EllipseData & lsst::gauss2d::Ellipse::get_data | ( | ) | const |
Return a const ref to this ellipse's data.
Definition at line 318 of file ellipse.cc.
|
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 319 of file ellipse.cc.
|
overridevirtual |
Get sigma_x.
Implements lsst::gauss2d::EllipseData.
Definition at line 320 of file ellipse.cc.
|
virtualinherited |
|
virtualinherited |
|
overridevirtual |
Get sigma_y.
Implements lsst::gauss2d::EllipseData.
Definition at line 321 of file ellipse.cc.
|
virtualinherited |
Get the square of sigma_y.
Definition at line 180 of file ellipse.cc.
|
virtualinherited |
Get sigma_x, sigma_y, rho.
Reimplemented in lsst::gauss2d::EllipseValues, lsst::gauss2d::fit::GaussianParametricEllipse, and lsst::gauss2d::fit::SersicEllipseData.
Definition at line 169 of file ellipse.cc.
std::shared_ptr< Ellipse > lsst::gauss2d::Ellipse::make_convolution | ( | const Ellipse & | ell | ) | const |
Return the convolution of this with another ellipse.
Convolution simply sums the values of the covariance matrix terms.
ell | The ellipse to convolve with. |
Definition at line 245 of file ellipse.cc.
std::unique_ptr< Ellipse > lsst::gauss2d::Ellipse::make_convolution_uniq | ( | const Ellipse & | ell | ) | const |
Same as make_convolution(), but returning a unique_ptr.
Definition at line 248 of file ellipse.cc.
|
inlinestaticinherited |
Definition at line 49 of file object.h.
bool lsst::gauss2d::Ellipse::operator!= | ( | const Ellipse & | other | ) | const |
Definition at line 316 of file ellipse.cc.
|
inlineinherited |
bool lsst::gauss2d::Ellipse::operator== | ( | const Ellipse & | other | ) | const |
Definition at line 315 of file ellipse.cc.
|
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 308 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.
|
virtualinherited |
Set sigma_x, sigma_y, rho.
Reimplemented in lsst::gauss2d::EllipseValues, lsst::gauss2d::fit::GaussianParametricEllipse, and lsst::gauss2d::fit::SersicEllipseData.
Definition at line 256 of file ellipse.cc.
|
virtualinherited |
Set hwhm_x, hwhm_y, rho (half-width at half-max)
Reimplemented in lsst::gauss2d::EllipseValues, lsst::gauss2d::fit::GaussianParametricEllipse, and lsst::gauss2d::fit::SersicEllipseData.
Definition at line 297 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 323 of file ellipse.cc.
|
overridevirtual |
Set the x-axis dispersion (sigma)
Implements lsst::gauss2d::EllipseData.
Definition at line 324 of file ellipse.cc.
|
overridevirtual |
Set the y-axis dispersion (sigma)
Implements lsst::gauss2d::EllipseData.
Definition at line 325 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 313 of file ellipse.cc.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |