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