lsst::gauss2d::fit::EllipticalComponent Class Reference

#include <ellipticalcomponent.h>

Inheritance diagram for lsst::gauss2d::fit::EllipticalComponent:

Public Member Functions
	EllipticalComponent (std::shared_ptr< ParametricEllipse > ellipse, std::shared_ptr< CentroidParameters > centroid=nullptr, std::shared_ptr< IntegralModel > integralmodel=nullptr)
const CentroidParameters &	get_centroid () const
	Get the centroid Parameter container.
const ParametricEllipse &	get_ellipse () const
	Get the ellipse Parameter container.
const IntegralModel &	get_integralmodel () const override
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.
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::ParametricModel
virtual void	add_extra_param_map (const Channel &channel, ExtraParamMap &map_extra, const GradParamMap &map_grad, ParameterMap &offsets) const =0
virtual void	add_extra_param_factors (const Channel &channel, ExtraParamFactors &factors) const =0
virtual void	add_grad_param_map (const Channel &channel, GradParamMap &map, ParameterMap &offsets) const =0
virtual void	add_grad_param_factors (const Channel &channel, GradParamFactors &factors) const =0
virtual void	set_extra_param_factors (const Channel &channel, ExtraParamFactors &factors, size_t index) const =0
virtual void	set_grad_param_factors (const Channel &channel, GradParamFactors &factors, size_t index) const =0
virtual std::unique_ptr< const lsst::gauss2d::Gaussians >	get_gaussians (const Channel &channel) const =0
virtual size_t	get_n_gaussians (const Channel &channel) const =0
	Return the number of Gaussian sub-components controlled by this model.
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.

Protected Attributes
std::shared_ptr< ParametricEllipse >	_ellipse
std::shared_ptr< CentroidParameters >	_centroid
std::shared_ptr< IntegralModel >	_integralmodel

Detailed Description

A Component with an elliptically-symmetric intensity profile.

Constructor & Destructor Documentation

EllipticalComponent()

lsst::gauss2d::fit::EllipticalComponent::EllipticalComponent ( std::shared_ptr< ParametricEllipse > ellipse, std::shared_ptr< CentroidParameters > centroid = nullptr, std::shared_ptr< IntegralModel > integralmodel = nullptr )

explicit

Construct an EllipticalComponent from Parameter containers

Parameters

ellipse	The ellipse Parameter container
centroid	The centroid Parameter container; default-constructed if null
integralmodel	The IntegralModel; default-constructed if null

Member Function Documentation

get_integralmodel()

const IntegralModel & lsst::gauss2d::fit::EllipticalComponent::get_integralmodel ( ) const

overridevirtual

Implements lsst::gauss2d::fit::Component.

get_parameters()

ParamRefs & lsst::gauss2d::fit::EllipticalComponent::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.

Reimplemented in lsst::gauss2d::fit::GaussianComponent, and lsst::gauss2d::fit::SersicMixComponent.

get_parameters_const()

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

overridevirtual

Same as get_parameters(), but for const refs.

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

Reimplemented in lsst::gauss2d::fit::GaussianComponent, and lsst::gauss2d::fit::SersicMixComponent.

---

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

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