LSST Applications g0fba68d861+5616995c1c,g1ebb85f214+2420ccdea7,g1fd858c14a+44c57a1f81,g21d47ad084+8e51fce9ac,g262e1987ae+1a7d68eb3b,g2cef7863aa+3bd8df3d95,g35bb328faa+fcb1d3bbc8,g36ff55ed5b+2420ccdea7,g47891489e3+5c6313fe9a,g53246c7159+fcb1d3bbc8,g646c943bdb+dbb9921566,g67b6fd64d1+5c6313fe9a,g6bd32b75b5+2420ccdea7,g74acd417e5+37fc0c974d,g786e29fd12+cf7ec2a62a,g86c591e316+6e13bcb9e9,g87389fa792+1e0a283bba,g89139ef638+5c6313fe9a,g90f42f885a+fce05a46d3,g9125e01d80+fcb1d3bbc8,g93e38de9ac+5345a64125,g95a1e89356+47d08a1cc6,g97be763408+bba861c665,ga9e4eb89a6+85210110a1,gb0b61e0e8e+1f27f70249,gb58c049af0+f03b321e39,gb89ab40317+5c6313fe9a,gc4e39d7843+4e09c98c3d,gd16ba4ae74+5402bcf54a,gd8ff7fe66e+2420ccdea7,gd9a9a58781+fcb1d3bbc8,gdab6d2f7ff+37fc0c974d,gde280f09ee+604b327636,ge278dab8ac+50e2446c94,ge410e46f29+5c6313fe9a,gef3c2e6661+6b480e0fb7,gf67bdafdda+5c6313fe9a,gffca2db377+fcb1d3bbc8,v29.2.0.rc1
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.