lsst::gauss2d::fit::LinearIntegralModel Class Reference

#include <linearintegralmodel.h>

Inheritance diagram for lsst::gauss2d::fit::LinearIntegralModel:

Public Types
typedef std::pair< std::reference_wrapper< const Channel >, std::shared_ptr< IntegralParameterD > >	ChannelIntegralParameterD
typedef std::vector< ChannelIntegralParameterD >	Data

Public Member Functions
	LinearIntegralModel (const Data *data_in)
std::shared_ptr< IntegralParameterD >	at (const Channel &channel)
	Get the IntegralParameterD for the given Channel.
std::shared_ptr< const IntegralParameterD >	at (const Channel &channel) const
	Get the (const) IntegralParameterD for the given Channel.
Data::iterator	begin () noexcept
Data::const_iterator	cbegin () const noexcept
Data::iterator	end () noexcept
Data::const_iterator	cend () const noexcept
std::vector< std::reference_wrapper< const Channel > >	get_channels () const override
	Get the set of channels this instance is applicable for.
double	get_integral (const Channel &channel) const override
	Get the value of the integral in a single Channel.
std::vector< std::pair< ParamBaseCRef, ExtraParamFactorValues > >	get_integral_derivative_factors (const Channel &channel) const override
	Return the partial derivative of the model w.r.t. each metaparameter.
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.
size_t	size () const
	Return the size of Data (number of Channel/IntegralParameterD instances).
std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
std::string	str () const override
const bool	operator< (const IntegralModel &m) const
const bool	operator== (const IntegralModel &m) const
const bool	operator!= (const IntegralModel &m) const
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

An IntegralModel with a single linear IntegralParameterD per Channel.

Constructor & Destructor Documentation

LinearIntegralModel()

lsst::gauss2d::fit::LinearIntegralModel::LinearIntegralModel ( const Data * data_in )

explicit

Construct a LinearIntegralModel from input Data.

Parameters

data_in

A map of IntegralParameterD shared_ptr to move for each Channel.

Note

No default initialization is provided, so data_in must not be null.

Member Function Documentation

get_channels()

std::vector< std::reference_wrapper< const Channel > > lsst::gauss2d::fit::LinearIntegralModel::get_channels ( ) const

overridevirtual

Get the set of channels this instance is applicable for.

Note

Implementers must return a set (all unique items). This cannot be enforced (yet).

Implements lsst::gauss2d::fit::Chromatic.

get_integral()

double lsst::gauss2d::fit::LinearIntegralModel::get_integral ( const Channel & channel ) const

overridevirtual

Get the value of the integral in a single Channel.

Implements lsst::gauss2d::fit::IntegralModel.

get_integral_derivative_factors()

std::vector< std::pair< ParamBaseCRef, ExtraParamFactorValues > > lsst::gauss2d::fit::LinearIntegralModel::get_integral_derivative_factors ( const Channel & channel ) const

overridevirtual

Return the partial derivative of the model w.r.t. each metaparameter.

This is generally needed only for nonlinear Parameter instances.

Parameters

channel

The Channel to return derivatives for.

Returns

A vector of Parameter/derivative pairs, with values ordered as specified in GaussianEvaluator (L, sigma_x, sigma_y).

Implements lsst::gauss2d::fit::IntegralModel.

get_parameters()

ParamRefs & lsst::gauss2d::fit::LinearIntegralModel::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::LinearIntegralModel::get_parameters_const ( ParamCRefs & params, ParamFilter * filter = nullptr ) const

overridevirtual

Same as get_parameters(), but for const refs.

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

---

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

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