lsst.gauss2d.fit g199a45376c+3b7b3fd841
 
Loading...
Searching...
No Matches
lsst::gauss2d::fit::GaussianParametricEllipse Class Reference

#include <gaussianparametricellipse.h>

Inheritance diagram for lsst::gauss2d::fit::GaussianParametricEllipse:
lsst::gauss2d::fit::ParametricEllipse lsst::gauss2d::fit::Parametric lsst::gauss2d::fit::QuasiEllipse

Public Member Functions

 GaussianParametricEllipse (std::shared_ptr< SigmaXParameterD > sigma_x, std::shared_ptr< SigmaYParameterD > sigma_y, std::shared_ptr< RhoParameterD > rho=nullptr)
 
 GaussianParametricEllipse (double sigma_x=0, double sigma_y=0, double rho=0)
 
ParamRefs & get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const override
 
ParamCRefs & get_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const override
 Same as get_parameters(), but for const refs.
 
double get_rho () const override
 Get the rho value.
 
double get_hwhm_x () const override
 
double get_hwhm_y () const override
 
double get_sigma_x () const override
 
double get_sigma_y () const override
 
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 the array of size_x, size_y, rho.
 
std::array< double, 3 > get_hxyr () const override
 
RhoParameterDget_rho_param () const override
 
SigmaXParameterDget_sigma_x_param () const
 Explicit alias for get_size_x_param.
 
SigmaYParameterDget_sigma_y_param () const
 Explicit alias for get_size_y_param.
 
SizeXParameterDget_size_x_param () const override
 
SizeYParameterDget_size_y_param () const override
 
std::shared_ptr< RhoParameterDget_rho_param_ptr () override
 
std::shared_ptr< SigmaXParameterDget_sigma_x_param_ptr ()
 Explicit alias for get_sigma_x_param_ptr.
 
std::shared_ptr< SigmaYParameterDget_sigma_y_param_ptr ()
 Explicit alias for get_sigma_y_param_ptr.
 
std::shared_ptr< SizeXParameterDget_size_x_param_ptr () override
 
std::shared_ptr< SizeYParameterDget_size_y_param_ptr () override
 
void set (double sigma_x, double sigma_y, double rho) override
 
void set_h (double hwhm_x, double hwhm_y, double rho) override
 
void set_rho (double rho) override
 
void set_hwhm_x (double hwhm_x) override
 
void set_hwhm_y (double hwhm_y) override
 
void set_sigma_x (double sigma_x) override
 
void set_sigma_y (double sigma_y) override
 
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
 
void set_xyr (const std::array< double, 3 > &xyr) override
 
std::string repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
 
std::string str () const override
 
- Public Member Functions inherited from lsst::gauss2d::fit::Parametric
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.
 

Detailed Description

A Parameter-based implementation of lsst::gauss2d::EllipseData and ParametricEllipse.

Constructor & Destructor Documentation

◆ GaussianParametricEllipse() [1/2]

lsst::gauss2d::fit::GaussianParametricEllipse::GaussianParametricEllipse ( std::shared_ptr< SigmaXParameterD > sigma_x,
std::shared_ptr< SigmaYParameterD > sigma_y,
std::shared_ptr< RhoParameterD > rho = nullptr )
explicit

Construct a GaussianParametricEllipse from Parameter instances.

Parameters
sigma_xThe SigmaXParameter to reference.
sigma_yThe SigmaYParameter to reference.
rhoThe RhoParameter to reference. Default-initialized if null.

◆ GaussianParametricEllipse() [2/2]

lsst::gauss2d::fit::GaussianParametricEllipse::GaussianParametricEllipse ( double sigma_x = 0,
double sigma_y = 0,
double rho = 0 )
explicit

Construct a GaussianParametricEllipse from values.

Parameters
sigma_xThe value of the otherwise default-initialized SigmaXParameter.
sigma_yThe value of the otherwise default-initialized SigmaYParameter.
rhoThe value of the otherwise default-initialized RhoParameter.

Member Function Documentation

◆ get_parameters()

ParamRefs & lsst::gauss2d::fit::GaussianParametricEllipse::get_parameters ( ParamRefs & params,
ParamFilter * filter = nullptr ) const
overridevirtual

Add Parameter refs matching the filter to a vector, in order.

Parameters
paramsThe vector to add to.
filterThe filter to apply to this Object's parameters.
Returns
A ref to params (for method chaining)

Implements lsst::gauss2d::fit::Parametric.

◆ get_parameters_const()

ParamCRefs & lsst::gauss2d::fit::GaussianParametricEllipse::get_parameters_const ( ParamCRefs & params,
ParamFilter * filter = nullptr ) const
overridevirtual

Same as get_parameters(), but for const refs.

Implements lsst::gauss2d::fit::Parametric.

◆ get_rho()

double lsst::gauss2d::fit::GaussianParametricEllipse::get_rho ( ) const
overridevirtual

Get the rho value.

Implements lsst::gauss2d::fit::QuasiEllipse.

◆ get_rho_param()

RhoParameterD & lsst::gauss2d::fit::GaussianParametricEllipse::get_rho_param ( ) const
overridevirtual

◆ get_rho_param_ptr()

std::shared_ptr< RhoParameterD > lsst::gauss2d::fit::GaussianParametricEllipse::get_rho_param_ptr ( )
overridevirtual

◆ get_size_x()

double lsst::gauss2d::fit::GaussianParametricEllipse::get_size_x ( ) const
overridevirtual

Get the size_x value.

Implements lsst::gauss2d::fit::QuasiEllipse.

◆ get_size_x_param()

SizeXParameterD & lsst::gauss2d::fit::GaussianParametricEllipse::get_size_x_param ( ) const
overridevirtual

◆ get_size_x_param_ptr()

std::shared_ptr< SizeXParameterD > lsst::gauss2d::fit::GaussianParametricEllipse::get_size_x_param_ptr ( )
overridevirtual

◆ get_size_y()

double lsst::gauss2d::fit::GaussianParametricEllipse::get_size_y ( ) const
overridevirtual

Get the size_y value.

Implements lsst::gauss2d::fit::QuasiEllipse.

◆ get_size_y_param()

SizeYParameterD & lsst::gauss2d::fit::GaussianParametricEllipse::get_size_y_param ( ) const
overridevirtual

◆ get_size_y_param_ptr()

std::shared_ptr< SizeYParameterD > lsst::gauss2d::fit::GaussianParametricEllipse::get_size_y_param_ptr ( )
overridevirtual

◆ get_xyr()

std::array< double, 3 > lsst::gauss2d::fit::GaussianParametricEllipse::get_xyr ( ) const
overridevirtual

Get the array of size_x, size_y, rho.

Reimplemented from lsst::gauss2d::fit::QuasiEllipse.

◆ set_rho()

void lsst::gauss2d::fit::GaussianParametricEllipse::set_rho ( double rho)
inlineoverridevirtual

◆ set_size_x()

void lsst::gauss2d::fit::GaussianParametricEllipse::set_size_x ( double sigma_x)
inlineoverridevirtual

◆ set_size_y()

void lsst::gauss2d::fit::GaussianParametricEllipse::set_size_y ( double sigma_y)
inlineoverridevirtual

◆ set_xyr()

void lsst::gauss2d::fit::GaussianParametricEllipse::set_xyr ( const std::array< double, 3 > & xyr)
overridevirtual

The documentation for this class was generated from the following files: