lsst::gauss2d::fit::SersicParametricEllipse Class Reference

#include <sersicparametricellipse.h>

Inheritance diagram for lsst::gauss2d::fit::SersicParametricEllipse:

Public Member Functions
	SersicParametricEllipse (std::shared_ptr< ReffXParameterD > size_x, std::shared_ptr< ReffYParameterD > size_y, std::shared_ptr< RhoParameterD > rho=nullptr)
	SersicParametricEllipse (double size_x=0, double size_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_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.
RhoParameterD &	get_rho_param () const override
SizeXParameterD &	get_size_x_param () const override
SizeYParameterD &	get_size_y_param () const override
std::shared_ptr< ReffXParameterD >	get_reff_x_param_ptr ()
std::shared_ptr< ReffYParameterD >	get_reff_y_param_ptr ()
std::shared_ptr< RhoParameterD >	get_rho_param_ptr () override
std::shared_ptr< SizeXParameterD >	get_size_x_param_ptr () override
std::shared_ptr< SizeYParameterD >	get_size_y_param_ptr () override
void	set_rho (double rho) override
void	set_size_x (double size_x) override
void	set_size_y (double size_y) 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::ParametricEllipse
virtual void	set_xyr (const std::array< double, 3 > &xyr)
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 ParametericEllipse with effective radius Parameters.

Constructor & Destructor Documentation

SersicParametricEllipse()

lsst::gauss2d::fit::SersicParametricEllipse::SersicParametricEllipse ( std::shared_ptr< ReffXParameterD > size_x, std::shared_ptr< ReffYParameterD > size_y, std::shared_ptr< RhoParameterD > rho = nullptr )

explicit

Construct a SersicParametricEllipse with existing Parameter instances.

Parameters

size_x	The x-axis effective radius parameter.
size_y	The y-axis effective radius parameter.
rho	The correlation (rho) parameter.

Member Function Documentation

get_parameters()

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

overridevirtual

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

Parameters

params	The vector to add to.
filter	The 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::SersicParametricEllipse::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::SersicParametricEllipse::get_rho ( ) const

overridevirtual

Get the rho value.

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

get_rho_param()

RhoParameterD & lsst::gauss2d::fit::SersicParametricEllipse::get_rho_param ( ) const

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

get_rho_param_ptr()

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

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

get_size_x()

double lsst::gauss2d::fit::SersicParametricEllipse::get_size_x ( ) const

overridevirtual

Get the size_x value.

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

get_size_x_param()

SizeXParameterD & lsst::gauss2d::fit::SersicParametricEllipse::get_size_x_param ( ) const

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

get_size_x_param_ptr()

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

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

get_size_y()

double lsst::gauss2d::fit::SersicParametricEllipse::get_size_y ( ) const

overridevirtual

Get the size_y value.

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

get_size_y_param()

SizeYParameterD & lsst::gauss2d::fit::SersicParametricEllipse::get_size_y_param ( ) const

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

get_size_y_param_ptr()

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

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

get_xyr()

std::array< double, 3 > lsst::gauss2d::fit::SersicParametricEllipse::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::SersicParametricEllipse::set_rho ( double rho )

inlineoverridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

set_size_x()

void lsst::gauss2d::fit::SersicParametricEllipse::set_size_x ( double size_x )

inlineoverridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

set_size_y()

void lsst::gauss2d::fit::SersicParametricEllipse::set_size_y ( double size_y )

inlineoverridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

---

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

• include/lsst/gauss2d/fit/sersicparametricellipse.h
• src/sersicparametricellipse.cc