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
Loading...
Searching...
No Matches
gaussianparametricellipse.h
Go to the documentation of this file.
1#ifndef LSST_GAUSS2D_FIT_GAUSSIANPARAMETRICELLIPSE_H
2#define LSST_GAUSS2D_FIT_GAUSSIANPARAMETRICELLIPSE_H
3
4#include <memory>
5
7
8#include "parameters.h"
9#include "parametricellipse.h"
10
11namespace lsst::gauss2d::fit {
16public:
26 std::shared_ptr<RhoParameterD> rho = nullptr);
34 explicit GaussianParametricEllipse(double sigma_x = 0, double sigma_y = 0, double rho = 0);
35
36 ParamRefs& get_parameters(ParamRefs& params, ParamFilter* filter = nullptr) const override;
37 ParamCRefs& get_parameters_const(ParamCRefs& params, ParamFilter* filter = nullptr) const override;
38
39 double get_rho() const override;
40 double get_hwhm_x() const override;
41 double get_hwhm_y() const override;
42 double get_sigma_x() const override;
43 double get_sigma_y() const override;
44 double get_size_x() const override;
45 double get_size_y() const override;
46
47 std::array<double, 3> get_xyr() const override;
48 std::array<double, 3> get_hxyr() const override;
49
50 RhoParameterD& get_rho_param() const override;
55 SizeXParameterD& get_size_x_param() const override;
56 SizeYParameterD& get_size_y_param() const override;
57
65
66 void set(double sigma_x, double sigma_y, double rho) override;
67 void set_h(double hwhm_x, double hwhm_y, double rho) override;
68 void set_rho(double rho) override;
69 void set_hwhm_x(double hwhm_x) override;
70 void set_hwhm_y(double hwhm_y) override;
71 void set_sigma_x(double sigma_x) override;
72 void set_sigma_y(double sigma_y) override;
73 void set_size_x(double sigma_x) override;
74 void set_size_y(double sigma_y) override;
75 void set_hxyr(const std::array<double, 3>& hxyr) override;
76 void set_xyr(const std::array<double, 3>& xyr) override;
77
78 std::string repr(bool name_keywords = false,
79 std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR) const override;
80 std::string str() const override;
81
82private:
86};
87} // namespace lsst::gauss2d::fit
88
89#endif
Interface for an object storing Ellipse data.
Definition ellipse.h:132
static constexpr std::string_view CC_NAMESPACE_SEPARATOR
The C++ namespace separator.
Definition object.h:45
std::string str() const override
Return a brief, human-readable string representation of this.
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.
double get_hwhm_x() const override
Get the x-axis half-width at half-maximum.
void set_hwhm_y(double hwhm_y) override
Set the y-axis half-width at half-max (FWHM/2)
void set_hwhm_x(double hwhm_x) override
Set the x-axis half-width at half-max (FWHM/2)
void set_sigma_y(double sigma_y) override
Set the y-axis dispersion (sigma)
SigmaXParameterD & get_sigma_x_param() const
Explicit alias for get_size_x_param.
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.
void set_rho(double rho) override
Set the correlation parameter (rho)
std::shared_ptr< SigmaYParameterD > get_sigma_y_param_ptr()
Explicit alias for get_sigma_y_param_ptr.
std::shared_ptr< SigmaXParameterD > get_sigma_x_param_ptr()
Explicit alias for get_sigma_x_param_ptr.
ParamRefs & get_parameters(ParamRefs &params, ParamFilter *filter=nullptr) const override
Add Parameter refs matching the filter to a vector, in order.
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.
SigmaYParameterD & get_sigma_y_param() const
Explicit alias for get_size_y_param.
std::shared_ptr< SizeXParameterD > get_size_x_param_ptr() override
double get_size_y() const override
Get the size_y value.
void set_hxyr(const std::array< double, 3 > &hxyr) override
Set hwhm_x, hwhm_y, rho from an array.
std::array< double, 3 > get_hxyr() const override
Get hwhm_x, hwhm_y, rho.
std::shared_ptr< RhoParameterD > get_rho_param_ptr() override
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)
double get_hwhm_y() const override
Get the y-axis half-width at half-maximum.
std::array< double, 3 > get_xyr() const override
Get sigma_x, sigma_y, rho.
void set_xyr(const std::array< double, 3 > &xyr) override
Set sigma_x, sigma_y, rho from an array.
ParamCRefs & get_parameters_const(ParamCRefs &params, ParamFilter *filter=nullptr) const override
Same as get_parameters(), but for const refs.
double get_size_x() const override
Get the size_x value.
std::vector< ParamBaseRef > ParamRefs
Definition param_defs.h:13
std::vector< ParamBaseCRef > ParamCRefs
Definition param_defs.h:11
Options for filtering Parameter instances.