A Parametric model for the integral of a 2D distribution. More...

#include <integralmodel.h>

Inheritance diagram for lsst::gauss2d::fit::IntegralModel:

Public Member Functions
virtual double	get_integral (const Channel &channel) const =0
	Get the value of the integral in a single Channel.

virtual std::vector< std::pair< ParamBaseCRef, ExtraParamFactorValues > >	get_integral_derivative_factors (const Channel &channel) const =0
	Return the partial derivative of the model w.r.t. each metaparameter.

Public Member Functions inherited from lsst::gauss2d::fit::Chromatic
virtual std::vector< std::reference_wrapper< const Channel > >	get_channels () const =0
	Get the set of channels this instance is applicable for.

Public Member Functions inherited from lsst::gauss2d::fit::Parametric
virtual ParamRefs &	get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const =0

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.

Detailed Description

A Parametric model for the integral of a 2D distribution.

IntegralModel implementations can use as many Parameter classes as needed. The model should be efficiently differentiable in the first order, via finite differencing if analytical evaluation is not possible.

IntegralModels may have meaningful ordering of channels but must enforce uniqueness constraints where relevant.

Member Function Documentation

◆ get_integral()

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

pure virtual

Get the value of the integral in a single Channel.

Implemented in lsst::gauss2d::fit::FractionalIntegralModel, lsst::gauss2d::fit::LinearIntegralModel, and lsst::gauss2d::fit::SersicModelIntegral.

◆ get_integral_derivative_factors()

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

pure virtual

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

Implemented in lsst::gauss2d::fit::FractionalIntegralModel, lsst::gauss2d::fit::LinearIntegralModel, and lsst::gauss2d::fit::SersicModelIntegral.

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

include/lsst/gauss2d/fit/integralmodel.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ get_integral()

◆ get_integral_derivative_factors()