A Parametric that can manage Parameter gradients and return Gaussians. More...

#include <parametricmodel.h>

Inheritance diagram for lsst::gauss2d::fit::ParametricModel:

Public Member Functions
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.

virtual ParamRefs &	get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const =0
	Add Parameter refs matching the filter to a vector, in order.

virtual ParamCRefs &	get_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const =0
	Same as get_parameters(), but for const refs.

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.

virtual std::string	repr (bool name_keywords=false, std::string_view namespace_separator=CC_NAMESPACE_SEPARATOR) const =0
	Return a full, callable string representation of this.

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

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 = "."

Detailed Description

A Parametric that can manage Parameter gradients and return Gaussians.

Note: See GaussianEvaluator for details on extra/grad param maps.

Definition at line 25 of file parametricmodel.h.

Member Function Documentation

◆ add_extra_param_factors()

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

pure virtual

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 virtual

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 virtual

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::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, 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 virtual

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_gaussians()

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

pure virtual

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::PsfModel, lsst::gauss2d::fit::SersicMixComponent, and lsst::gauss2d::fit::Source.

◆ get_n_gaussians()

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

pure virtual

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::PsfModel, lsst::gauss2d::fit::SersicMixComponent, and lsst::gauss2d::fit::Source.

◆ get_parameters()

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

pure virtualinherited

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)

◆ get_parameters_const()

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

pure virtualinherited

Same as get_parameters(), but for const refs.

◆ 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()

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

pure virtualinherited

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.

◆ set_extra_param_factors()

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

pure virtual

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 virtual

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::GaussianComponent, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, and lsst::gauss2d::fit::Source.

◆ str()

virtual std::string lsst::gauss2d::Object::str ( ) const

pure virtualinherited

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

Member Data Documentation

◆ CC_NAMESPACE_SEPARATOR

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

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

staticconstexprinherited

Definition at line 46 of file object.h.

◆ PY_NAMESPACE_SEPARATOR

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 file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/gauss2d_fit/g199a45376c+0ba108daf9/include/lsst/gauss2d/fit/parametricmodel.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ add_extra_param_factors()

◆ add_extra_param_map()

◆ add_grad_param_factors()

◆ add_grad_param_map()

◆ get_gaussians()

◆ 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

◆ CC_NAMESPACE_SEPARATOR

◆ NULL_STR_GENERAL

◆ PY_NAMESPACE_SEPARATOR