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 representation of a 2D Gaussian with x and y standard deviations and a covariance value. More...
#include <ellipse.h>
Public Member Functions | |
Covariance (double sigma_x_sq=0, double sigma_y_sq=0, double cov_xy=0) | |
Construct a new Covariance object. | |
Covariance (const Ellipse &ell) | |
Construct a covariance using values from an ellipse instance. | |
void | convolve (const Covariance &cov) |
Convolve with another covariance, adding the values of each parameter to this. | |
double | get_sigma_x_sq () const |
Get the square of sigma_x. | |
double | get_sigma_y_sq () const |
Get the square of sigma_y. | |
double | get_cov_xy () const |
Get the covariance. | |
std::array< double, 3 > | get_xyc () const |
Get the array of sigma_x^2, sigma_y^2, covariance. | |
std::shared_ptr< Covariance > | make_convolution (const Covariance &cov) const |
Return the convolution of this with another covariance. | |
std::unique_ptr< Covariance > | make_convolution_uniq (const Covariance &cov) const |
Same as make_convolution(), but returning a unique_ptr. | |
void | set (const Ellipse &ellipse) |
Set values from an ellipse instance. | |
void | set (double sigma_x_sq=0, double sigma_y_sq=0, double cov_xy=0) |
Set all values at once. | |
void | set_sigma_x_sq (double sigma_x_sq) |
Set the square of sigma_x. | |
void | set_sigma_y_sq (double sigma_y_sq) |
Set the square of sigma_y. | |
void | set_cov_xy (double cov_xy) |
Set the off-diagonal (covariance) term. | |
void | set_xyc (const std::array< double, 3 > &xyc) |
Set sigma_x_sq, sigma_y_sq and cov_xy from an array ref. | |
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 Covariance &other) const |
bool | operator!= (const Covariance &other) const |
Static Public Member Functions | |
static void | check (double sigma_x_sq, double sigma_y_sq, double cov_xy) |
Check whether the supplied values are valid, throwing if not. | |
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 = "." |
Friends | |
std::ostream & | operator<< (std::ostream &out, const Covariance &obj) |
A representation of a 2D Gaussian with x and y standard deviations and a covariance value.
This ellipse representation is intended for intermediate calculations and does not use an abstract Data class.
|
explicit |
Construct a new Covariance object.
sigma_x_sq | The value of sigma_x^2 |
sigma_y_sq | The value of sigma_y^2 |
cov_xy | The value of the covariance |
Definition at line 40 of file ellipse.cc.
|
explicit |
Construct a covariance using values from an ellipse instance.
Definition at line 44 of file ellipse.cc.
|
static |
Check whether the supplied values are valid, throwing if not.
Definition at line 46 of file ellipse.cc.
void lsst::gauss2d::Covariance::convolve | ( | const Covariance & | cov | ) |
Convolve with another covariance, adding the values of each parameter to this.
Definition at line 59 of file ellipse.cc.
|
inline |
|
inline |
|
inline |
|
inline |
std::shared_ptr< Covariance > lsst::gauss2d::Covariance::make_convolution | ( | const Covariance & | cov | ) | const |
Return the convolution of this with another covariance.
Convolution simply sums the values of each respective parameter.
cov | The covariance to convolve with. |
Definition at line 66 of file ellipse.cc.
std::unique_ptr< Covariance > lsst::gauss2d::Covariance::make_convolution_uniq | ( | const Covariance & | cov | ) | const |
Same as make_convolution(), but returning a unique_ptr.
|
inlinestaticinherited |
Definition at line 49 of file object.h.
bool lsst::gauss2d::Covariance::operator!= | ( | const Covariance & | other | ) | const |
Definition at line 135 of file ellipse.cc.
bool lsst::gauss2d::Covariance::operator== | ( | const Covariance & | other | ) | const |
Definition at line 134 of file ellipse.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 122 of file ellipse.cc.
void lsst::gauss2d::Covariance::set | ( | const Ellipse & | ellipse | ) |
Set values from an ellipse instance.
Definition at line 73 of file ellipse.cc.
void lsst::gauss2d::Covariance::set | ( | double | sigma_x_sq = 0, |
double | sigma_y_sq = 0, | ||
double | cov_xy = 0 ) |
Set all values at once.
Definition at line 83 of file ellipse.cc.
void lsst::gauss2d::Covariance::set_cov_xy | ( | double | cov_xy | ) |
Set the off-diagonal (covariance) term.
Definition at line 105 of file ellipse.cc.
void lsst::gauss2d::Covariance::set_sigma_x_sq | ( | double | sigma_x_sq | ) |
Set the square of sigma_x.
Definition at line 89 of file ellipse.cc.
void lsst::gauss2d::Covariance::set_sigma_y_sq | ( | double | sigma_y_sq | ) |
Set the square of sigma_y.
Definition at line 97 of file ellipse.cc.
void lsst::gauss2d::Covariance::set_xyc | ( | const std::array< double, 3 > & | xyc | ) |
Set sigma_x_sq, sigma_y_sq and cov_xy from an array ref.
Definition at line 120 of file ellipse.cc.
|
overridevirtual |
Return a brief, human-readable string representation of this.
Implements lsst::gauss2d::Object.
Definition at line 129 of file ellipse.cc.
|
friend |
Definition at line 137 of file ellipse.cc.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |