lsst::gauss2d::fit::SersicMixComponent Class Reference

A Gaussian mixture approximation to a Sersic profile Component. More...

#include <sersicmixcomponent.h>

Inheritance diagram for lsst::gauss2d::fit::SersicMixComponent:

Classes
class	SersicMixGaussianComponent

Public Member Functions
	SersicMixComponent (std::shared_ptr< SersicParametricEllipse > ellipse=nullptr, std::shared_ptr< CentroidParameters > centroid=nullptr, std::shared_ptr< IntegralModel > integralmodel=nullptr, std::shared_ptr< SersicMixComponentIndexParameterD > sersicindex=nullptr)
void	add_extra_param_map (const Channel &channel, ExtraParamMap &map_extra, const GradParamMap &map_grad, ParameterMap &offsets) const override
void	add_extra_param_factors (const Channel &channel, ExtraParamFactors &factors) const override
void	add_grad_param_map (const Channel &channel, GradParamMap &map, ParameterMap &offsets) const override
void	add_grad_param_factors (const Channel &channel, GradParamFactors &factor) const override
std::unique_ptr< const lsst::gauss2d::Gaussians >	get_gaussians (const Channel &channel) const override
size_t	get_n_gaussians (const Channel &channel) const override
	Return the number of Gaussian sub-components controlled by this model.
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_sersicindex () const
SersicMixComponentIndexParameterD &	get_sersicindex_param () const
std::shared_ptr< SersicMixComponentIndexParameterD >	get_sersicindex_param_ptr ()
void	set_extra_param_factors (const Channel &channel, ExtraParamFactors &factors, size_t index) const override
void	set_grad_param_factors (const Channel &channel, GradParamFactors &factors, size_t index) const override
void	set_sersicindex (double value)
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::EllipticalComponent
	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
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.

Static Public Attributes
static const size_t	N_PARAMS = N_PARAMS_GAUSS2D + 1

Additional Inherited Members
Protected Attributes inherited from lsst::gauss2d::fit::EllipticalComponent
std::shared_ptr< ParametricEllipse >	_ellipse
std::shared_ptr< CentroidParameters >	_centroid
std::shared_ptr< IntegralModel >	_integralmodel

Detailed Description

A Gaussian mixture approximation to a Sersic profile Component.

This Component approximates the Sersic (1968) profile, which is a widely-used (in astronomy) exponentially-declining radial profile with a single shape parameter. It is also functionally a generalization of the Gaussian (Sersic index n=0.5), exponential (n=1) and de Vaucouleurs (1948) (n=4) profiles.

This particular implementation closely matches the majority of the profile, but deliberately excludes the very inner and outermost regions.

Note

See Graham & Driver 2005 for a useful summary of various properties of the Sersic profile.

Member Function Documentation

add_extra_param_factors()

void lsst::gauss2d::fit::SersicMixComponent::add_extra_param_factors ( const Channel & channel, ExtraParamFactors & factors ) const

overridevirtual

Add extra Parameter gradient factors to an existing vector.

Parameters

channel	The Channel to add factors for.
factors	The ExtraParamFactors to add to.

Implements lsst::gauss2d::fit::ParametricModel.

add_extra_param_map()

void lsst::gauss2d::fit::SersicMixComponent::add_extra_param_map ( const Channel & channel, ExtraParamMap & map_extra, const GradParamMap & map_grad, ParameterMap & offsets ) const

overridevirtual

Add extra Parameter indices to a map.

Parameters

channel	The Channel to add indices for.
map_extra	The ExtraParamMap to add to.
map_grad	The completed GradParamMap.
offsets	A map of index offsets for Parameters that have already been added.

Implements lsst::gauss2d::fit::ParametricModel.

add_grad_param_factors()

void lsst::gauss2d::fit::SersicMixComponent::add_grad_param_factors ( const Channel & channel, GradParamFactors & factors ) const

overridevirtual

Add Parameter gradient factors to an existing map.

Parameters

channel	The Channel to add factors for.
factors	The GradParamFactors to add to.

Implements lsst::gauss2d::fit::ParametricModel.

add_grad_param_map()

void lsst::gauss2d::fit::SersicMixComponent::add_grad_param_map ( const Channel & channel, GradParamMap & map, ParameterMap & offsets ) const

overridevirtual

Add Parameter gradient indices to an existing map.

Parameters

channel	The Channel to add indices for.
map	The map to add to.
offsets	A map of index offsets for Parameters that have already been added.

Implements lsst::gauss2d::fit::ParametricModel.

get_gaussians()

std::unique_ptr< const lsst::gauss2d::Gaussians > lsst::gauss2d::fit::SersicMixComponent::get_gaussians ( const Channel & channel ) const

overridevirtual

Return the vector of Gaussian sub-components controlled by this model.

Parameters

channel

The Channel to return Gaussians for.

Returns

The Gaussians controlled by this model.

Implements lsst::gauss2d::fit::ParametricModel.

get_n_gaussians()

size_t lsst::gauss2d::fit::SersicMixComponent::get_n_gaussians ( const Channel & channel ) const

overridevirtual

Return the number of Gaussian sub-components controlled by this model.

Implements lsst::gauss2d::fit::ParametricModel.

get_parameters()

ParamRefs & lsst::gauss2d::fit::SersicMixComponent::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)

Reimplemented from lsst::gauss2d::fit::EllipticalComponent.

get_parameters_const()

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

overridevirtual

Same as get_parameters(), but for const refs.

Reimplemented from lsst::gauss2d::fit::EllipticalComponent.

set_extra_param_factors()

void lsst::gauss2d::fit::SersicMixComponent::set_extra_param_factors ( const Channel & channel, ExtraParamFactors & factors, size_t index ) const

overridevirtual

Set extra Parameter gradient factors in an existing map.

Parameters

channel	The Channel to set factors for.
factors	The ExtraParamFactors to set factors for.
index	The index to begin setting factors at.

Implements lsst::gauss2d::fit::ParametricModel.

set_grad_param_factors()

void lsst::gauss2d::fit::SersicMixComponent::set_grad_param_factors ( const Channel & channel, GradParamFactors & factors, size_t index ) const

overridevirtual

Set Parameter gradient factors in an existing map.

Parameters

channel	The Channel to set factors for.
factors	The GradParamFactors to set factors for.
index	The index to begin setting factors at.

Implements lsst::gauss2d::fit::ParametricModel.

---

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

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