A Component with an elliptically-symmetric intensity profile. More...

#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)
	Construct an EllipticalComponent from Parameter containers.

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
	Add Parameter refs matching the filter to a vector, in order.

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
	Return a full, callable string representation of this.

std::string	str () const override
	Return a brief, human-readable string representation of this.

virtual void	add_extra_param_map (const Channel &channel, ExtraParamMap &map_extra, const GradParamMap &map_grad, ParameterMap &offsets) const =0
	Add extra Parameter indices to a map.

virtual void	add_extra_param_factors (const Channel &channel, ExtraParamFactors &factors) const =0
	Add extra Parameter gradient factors to an existing vector.

virtual void	add_grad_param_map (const Channel &channel, GradParamMap &map, ParameterMap &offsets) const =0
	Add Parameter gradient indices to an existing map.

virtual void	add_grad_param_factors (const Channel &channel, GradParamFactors &factors) const =0
	Add Parameter gradient factors to an existing map.

virtual void	set_extra_param_factors (const Channel &channel, ExtraParamFactors &factors, size_t index) const =0
	Set extra Parameter gradient factors in an existing map.

virtual void	set_grad_param_factors (const Channel &channel, GradParamFactors &factors, size_t index) const =0
	Set Parameter gradient factors in an existing map.

virtual std::unique_ptr< const lsst::gauss2d::Gaussians >	get_gaussians (const Channel &channel) const =0
	Return the vector of Gaussian sub-components controlled by this model.

virtual size_t	get_n_gaussians (const Channel &channel) const =0
	Return the number of Gaussian sub-components controlled by this model.

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 Member Functions
static std::string_view	null_str (const std::string_view &namespace_separator)

Static Public Attributes
static constexpr std::string_view	CC_NAMESPACE_SEPARATOR = "::"
	The C++ namespace separator.

static constexpr std::string_view	NULL_STR_GENERAL = "None"

static constexpr std::string_view	PY_NAMESPACE_SEPARATOR = "."

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.

Definition at line 15 of file ellipticalcomponent.h.

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

Definition at line 13 of file ellipticalcomponent.cc.

        : _ellipse(std::move(ellipse)),
          _centroid(centroid ? std::move(centroid) : std::make_shared<CentroidParameters>()),
          _integralmodel(integralmodel ? std::move(integralmodel)
                                       : std::make_shared<LinearIntegralModel>(nullptr)) {
    if (_ellipse == nullptr) throw std::invalid_argument("ellipse must not be null");
}

Member Function Documentation

◆ add_extra_param_factors()

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

pure virtualinherited

Add extra Parameter gradient factors to an existing vector.

Parameters

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

Implemented in lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, and lsst::gauss2d::fit::Source.

◆ add_extra_param_map()

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

pure virtualinherited

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.

Implemented in lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, and lsst::gauss2d::fit::Source.

◆ add_grad_param_factors()

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

pure virtualinherited

Add Parameter gradient factors to an existing map.

Parameters

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

Implemented in lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, and lsst::gauss2d::fit::Source.

◆ add_grad_param_map()

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

pure virtualinherited

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.

Implemented in lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, and lsst::gauss2d::fit::Source.

◆ get_centroid()

const CentroidParameters & lsst::gauss2d::fit::EllipticalComponent::get_centroid ( ) const

Get the centroid Parameter container.

Definition at line 23 of file ellipticalcomponent.cc.

23{ return *_centroid; }

◆ get_ellipse()

const ParametricEllipse & lsst::gauss2d::fit::EllipticalComponent::get_ellipse ( ) const

Get the ellipse Parameter container.

Definition at line 24 of file ellipticalcomponent.cc.

24{ return *_ellipse; }

◆ get_gaussians()

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

pure virtualinherited

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.

Implemented in lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::Source, and lsst::gauss2d::fit::PsfModel.

◆ get_integralmodel()

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

overridevirtual

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

Definition at line 25 of file ellipticalcomponent.cc.

25{ return *_integralmodel; }

◆ get_n_gaussians()

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

pure virtualinherited

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

Implemented in lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::Source, and lsst::gauss2d::fit::PsfModel.

◆ 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.

Definition at line 27 of file ellipticalcomponent.cc.

                                                                                           {
    _centroid->get_parameters(params, filter);
    _ellipse->get_parameters(params, filter);
    _integralmodel->get_parameters(params, filter);
    return params;
}

◆ 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.

Definition at line 34 of file ellipticalcomponent.cc.

                                                                                                   {
    _centroid->get_parameters_const(params, filter);
    _ellipse->get_parameters_const(params, filter);
    _integralmodel->get_parameters_const(params, filter);
    return params;
}

◆ get_parameters_const_new()

ParamCRefs lsst::gauss2d::fit::Parametric::get_parameters_const_new ( ParamFilter * filter = nullptr ) const

inlineinherited

Same as get_parameters_const(), but returning a new vector.

Definition at line 33 of file parametric.h.

                                                                             {
        ParamCRefs params{};
        get_parameters_const(params, filter);
        return params;
    }

◆ get_parameters_new()

ParamRefs lsst::gauss2d::fit::Parametric::get_parameters_new ( ParamFilter * filter = nullptr ) const

inlineinherited

Same as get_parameters(), but returning a new vector.

Definition at line 27 of file parametric.h.

                                                                      {
        ParamRefs params{};
        get_parameters(params, filter);
        return params;
    }

◆ null_str()

static std::string_view lsst::gauss2d::Object::null_str ( const std::string_view & namespace_separator )

inlinestaticinherited

Definition at line 49 of file object.h.

                                                                              {
        return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
    }

◆ repr()

std::string lsst::gauss2d::fit::EllipticalComponent::repr	(	bool	name_keywords = false,
		std::string_view	namespace_separator = Object::CC_NAMESPACE_SEPARATOR ) const

overridevirtual

Return a full, callable string representation of this.

Parameters

name_keywords	Whether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separator	The string to use to delimit namespaces, i.e. :: in C++ and . in Python.

Returns: A callable string representation of this, which should return an an identical object to this.

Note: The representation with name_keywords=false must be callable in C++. The representation with name_keywords=true should be callable in Python, if there are any bindings.

Implements lsst::gauss2d::Object.

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

Definition at line 41 of file ellipticalcomponent.cc.

                                                                                                {
    return (name_keywords ? "ellipse=" : "") + _ellipse->repr(name_keywords, namespace_separator) + ", "
           + (name_keywords ? "centroid=" : "") + _centroid->repr(name_keywords, namespace_separator) + ", "
           + (name_keywords ? "integralmodel=" : "")
           + _integralmodel->repr(name_keywords, namespace_separator);
}

◆ set_extra_param_factors()

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

pure virtualinherited

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.

Implemented in lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, and lsst::gauss2d::fit::Source.

◆ set_grad_param_factors()

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

pure virtualinherited

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.

Implemented in lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::SersicMixComponent, and lsst::gauss2d::fit::Source.

◆ str()

std::string lsst::gauss2d::fit::EllipticalComponent::str ( ) const

overridevirtual

Return a brief, human-readable string representation of this.

Implements lsst::gauss2d::Object.

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

Definition at line 48 of file ellipticalcomponent.cc.

                                         {
    return "ellipse=" + _ellipse->str() + ", centroid=" + _centroid->str()
           + ", integralmodel=" + _integralmodel->str();
}

Member Data Documentation

◆ _centroid

std::shared_ptr<CentroidParameters> lsst::gauss2d::fit::EllipticalComponent::_centroid

protected

Definition at line 42 of file ellipticalcomponent.h.

◆ _ellipse

std::shared_ptr<ParametricEllipse> lsst::gauss2d::fit::EllipticalComponent::_ellipse

protected

Definition at line 41 of file ellipticalcomponent.h.

◆ _integralmodel

std::shared_ptr<IntegralModel> lsst::gauss2d::fit::EllipticalComponent::_integralmodel

protected

Definition at line 43 of file ellipticalcomponent.h.

◆ CC_NAMESPACE_SEPARATOR

constexpr std::string_view lsst::gauss2d::Object::CC_NAMESPACE_SEPARATOR = "::"

staticconstexprinherited

The C++ namespace separator.

Definition at line 45 of file object.h.

◆ NULL_STR_GENERAL

constexpr std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"

staticconstexprinherited

Definition at line 46 of file object.h.

◆ PY_NAMESPACE_SEPARATOR

constexpr std::string_view lsst::gauss2d::Object::PY_NAMESPACE_SEPARATOR = "."

staticconstexprinherited

Definition at line 47 of file object.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d_fit/gb58c049af0+d64f4d3760/include/lsst/gauss2d/fit/ellipticalcomponent.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d_fit/gb58c049af0+d64f4d3760/src/ellipticalcomponent.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EllipticalComponent()

Member Function Documentation

◆ add_extra_param_factors()

◆ add_extra_param_map()

◆ add_grad_param_factors()

◆ add_grad_param_map()

◆ get_centroid()

◆ get_ellipse()

◆ get_gaussians()

◆ get_integralmodel()

◆ get_n_gaussians()

◆ get_parameters()

◆ get_parameters_const()

◆ get_parameters_const_new()

◆ get_parameters_new()

◆ null_str()

◆ repr()

◆ set_extra_param_factors()

◆ set_grad_param_factors()

◆ str()

Member Data Documentation

◆ _centroid

◆ _ellipse

◆ _integralmodel

◆ CC_NAMESPACE_SEPARATOR

◆ NULL_STR_GENERAL

◆ PY_NAMESPACE_SEPARATOR