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 Parameter-based implementation of lsst::gauss2d::EllipseData and ParametricEllipse. More...
#include <gaussianparametricellipse.h>
Public Member Functions | |
GaussianParametricEllipse (std::shared_ptr< SigmaXParameterD > sigma_x, std::shared_ptr< SigmaYParameterD > sigma_y, std::shared_ptr< RhoParameterD > rho=nullptr) | |
Construct a GaussianParametricEllipse from Parameter instances. | |
GaussianParametricEllipse (double sigma_x=0, double sigma_y=0, double rho=0) | |
Construct a GaussianParametricEllipse from values. | |
ParamRefs & | get_parameters (ParamRefs ¶ms, ParamFilter *filter=nullptr) const override |
Add Parameter refs matching the filter to a vector, in order. | |
ParamCRefs & | get_parameters_const (ParamCRefs ¶ms, ParamFilter *filter=nullptr) const override |
Same as get_parameters(), but for const refs. | |
double | get_rho () const override |
Get rho. | |
double | get_hwhm_x () const override |
Get the x-axis half-width at half-maximum. | |
double | get_hwhm_y () const override |
Get the y-axis half-width at half-maximum. | |
double | get_sigma_x () const override |
Get sigma_x. | |
double | get_sigma_y () const override |
Get sigma_y. | |
double | get_size_x () const override |
Get the size_x value. | |
double | get_size_y () const override |
Get the size_y value. | |
std::array< double, 3 > | get_xyr () const override |
Get sigma_x, sigma_y, rho. | |
std::array< double, 3 > | get_hxyr () const override |
Get hwhm_x, hwhm_y, rho. | |
RhoParameterD & | get_rho_param () const override |
SigmaXParameterD & | get_sigma_x_param () const |
Explicit alias for get_size_x_param. | |
SigmaYParameterD & | get_sigma_y_param () const |
Explicit alias for get_size_y_param. | |
SizeXParameterD & | get_size_x_param () const override |
SizeYParameterD & | get_size_y_param () const override |
std::shared_ptr< RhoParameterD > | get_rho_param_ptr () override |
std::shared_ptr< SigmaXParameterD > | get_sigma_x_param_ptr () |
Explicit alias for get_sigma_x_param_ptr. | |
std::shared_ptr< SigmaYParameterD > | get_sigma_y_param_ptr () |
Explicit alias for get_sigma_y_param_ptr. | |
std::shared_ptr< SizeXParameterD > | get_size_x_param_ptr () override |
std::shared_ptr< SizeYParameterD > | get_size_y_param_ptr () override |
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_rho (double rho) override |
Set the correlation parameter (rho) | |
void | set_hwhm_x (double hwhm_x) override |
Set the x-axis half-width at half-max (FWHM/2) | |
void | set_hwhm_y (double hwhm_y) override |
Set the y-axis half-width at half-max (FWHM/2) | |
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_size_x (double sigma_x) override |
void | set_size_y (double sigma_y) override |
void | set_hxyr (const std::array< double, 3 > &hxyr) override |
Set hwhm_x, hwhm_y, rho from an array. | |
void | set_xyr (const std::array< double, 3 > &xyr) override |
Set sigma_x, sigma_y, rho from an array. | |
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_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 void | set (const Covariance &covar) |
Set values from a Covariance object. | |
virtual void | set (const EllipseMajor &ellipse) |
Set values from an EllipseMajor object. | |
bool | operator== (const EllipseData &other) const |
bool | operator!= (const EllipseData &other) const |
ParamRefs | get_parameters_new (ParamFilter *filter=nullptr) const |
Same as get_parameters(), but returning a new vector. | |
ParamCRefs | get_parameters_const_new (ParamFilter *filter=nullptr) const |
Same as get_parameters_const(), but returning a new vector. | |
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 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 = "." |
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 = "." |
A Parameter-based implementation of lsst::gauss2d::EllipseData and ParametricEllipse.
Definition at line 15 of file gaussianparametricellipse.h.
|
explicit |
Construct a GaussianParametricEllipse from Parameter instances.
sigma_x | The SigmaXParameter to reference. |
sigma_y | The SigmaYParameter to reference. |
rho | The RhoParameter to reference. Default-initialized if null. |
Definition at line 17 of file gaussianparametricellipse.cc.
|
explicit |
Construct a GaussianParametricEllipse from values.
sigma_x | The value of the otherwise default-initialized SigmaXParameter. |
sigma_y | The value of the otherwise default-initialized SigmaYParameter. |
rho | The value of the otherwise default-initialized RhoParameter. |
Definition at line 23 of file gaussianparametricellipse.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 |
|
overridevirtual |
Get the x-axis half-width at half-maximum.
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 36 of file gaussianparametricellipse.cc.
|
overridevirtual |
Get the y-axis half-width at half-maximum.
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 39 of file gaussianparametricellipse.cc.
|
overridevirtual |
Get hwhm_x, hwhm_y, rho.
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 47 of file gaussianparametricellipse.cc.
|
overridevirtual |
Add Parameter refs matching the filter to a vector, in order.
params | The vector to add to. |
filter | The filter to apply to this Object's parameters. |
Implements lsst::gauss2d::fit::Parametric.
Definition at line 28 of file gaussianparametricellipse.cc.
|
overridevirtual |
Same as get_parameters(), but for const refs.
Implements lsst::gauss2d::fit::Parametric.
Definition at line 32 of file gaussianparametricellipse.cc.
|
inlineinherited |
Same as get_parameters_const(), but returning a new vector.
Definition at line 33 of file parametric.h.
|
inlineinherited |
Same as get_parameters(), but returning a new vector.
Definition at line 27 of file parametric.h.
|
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 42 of file gaussianparametricellipse.cc.
|
overridevirtual |
Implements lsst::gauss2d::fit::ParametricEllipse.
Definition at line 55 of file gaussianparametricellipse.cc.
|
overridevirtual |
Implements lsst::gauss2d::fit::ParametricEllipse.
Definition at line 61 of file gaussianparametricellipse.cc.
|
overridevirtual |
Get sigma_x.
Implements lsst::gauss2d::EllipseData.
Definition at line 43 of file gaussianparametricellipse.cc.
SigmaXParameterD & lsst::gauss2d::fit::GaussianParametricEllipse::get_sigma_x_param | ( | ) | const |
Explicit alias for get_size_x_param.
Definition at line 56 of file gaussianparametricellipse.cc.
std::shared_ptr< SigmaXParameterD > lsst::gauss2d::fit::GaussianParametricEllipse::get_sigma_x_param_ptr | ( | ) |
Explicit alias for get_sigma_x_param_ptr.
Definition at line 62 of file gaussianparametricellipse.cc.
|
virtualinherited |
|
virtualinherited |
|
overridevirtual |
Get sigma_y.
Implements lsst::gauss2d::EllipseData.
Definition at line 44 of file gaussianparametricellipse.cc.
SigmaYParameterD & lsst::gauss2d::fit::GaussianParametricEllipse::get_sigma_y_param | ( | ) | const |
Explicit alias for get_size_y_param.
Definition at line 57 of file gaussianparametricellipse.cc.
std::shared_ptr< SigmaYParameterD > lsst::gauss2d::fit::GaussianParametricEllipse::get_sigma_y_param_ptr | ( | ) |
Explicit alias for get_sigma_y_param_ptr.
Definition at line 63 of file gaussianparametricellipse.cc.
|
virtualinherited |
Get the square of sigma_y.
Definition at line 180 of file ellipse.cc.
|
overridevirtual |
Get the size_x value.
Implements lsst::gauss2d::fit::QuasiEllipse.
Definition at line 45 of file gaussianparametricellipse.cc.
|
overridevirtual |
Implements lsst::gauss2d::fit::ParametricEllipse.
Definition at line 58 of file gaussianparametricellipse.cc.
|
overridevirtual |
Implements lsst::gauss2d::fit::ParametricEllipse.
Definition at line 64 of file gaussianparametricellipse.cc.
|
overridevirtual |
Get the size_y value.
Implements lsst::gauss2d::fit::QuasiEllipse.
Definition at line 46 of file gaussianparametricellipse.cc.
|
overridevirtual |
Implements lsst::gauss2d::fit::ParametricEllipse.
Definition at line 59 of file gaussianparametricellipse.cc.
|
overridevirtual |
Implements lsst::gauss2d::fit::ParametricEllipse.
Definition at line 65 of file gaussianparametricellipse.cc.
|
overridevirtual |
Get sigma_x, sigma_y, rho.
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 51 of file gaussianparametricellipse.cc.
|
inlinestaticinherited |
Definition at line 49 of file object.h.
|
inlinestaticinherited |
|
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 95 of file gaussianparametricellipse.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 67 of file gaussianparametricellipse.cc.
|
overridevirtual |
Set hwhm_x, hwhm_y, rho (half-width at half-max)
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 72 of file gaussianparametricellipse.cc.
|
inlineoverridevirtual |
Set the x-axis half-width at half-max (FWHM/2)
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 77 of file gaussianparametricellipse.cc.
|
inlineoverridevirtual |
Set the y-axis half-width at half-max (FWHM/2)
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 80 of file gaussianparametricellipse.cc.
|
overridevirtual |
Set hwhm_x, hwhm_y, rho from an array.
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 88 of file gaussianparametricellipse.cc.
|
inlineoverridevirtual |
Set the correlation parameter (rho)
Implements lsst::gauss2d::EllipseData.
Definition at line 83 of file gaussianparametricellipse.cc.
|
inlineoverridevirtual |
Set the x-axis dispersion (sigma)
Implements lsst::gauss2d::EllipseData.
Definition at line 84 of file gaussianparametricellipse.cc.
|
inlineoverridevirtual |
Set the y-axis dispersion (sigma)
Implements lsst::gauss2d::EllipseData.
Definition at line 85 of file gaussianparametricellipse.cc.
|
inlineoverridevirtual |
Implements lsst::gauss2d::fit::ParametricEllipse.
Definition at line 86 of file gaussianparametricellipse.cc.
|
inlineoverridevirtual |
Implements lsst::gauss2d::fit::ParametricEllipse.
Definition at line 87 of file gaussianparametricellipse.cc.
|
overridevirtual |
Set sigma_x, sigma_y, rho from an array.
Reimplemented from lsst::gauss2d::EllipseData.
Definition at line 91 of file gaussianparametricellipse.cc.
|
overridevirtual |
Return a brief, human-readable string representation of this.
Implements lsst::gauss2d::EllipseData.
Definition at line 102 of file gaussianparametricellipse.cc.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |