Fit functions describing peak shapes, like Gaus or Lorentz with optional background function. More...

#include <FitFunction.h>

Inheritance diagram for ant::calibration::gui::PeakingFitFunction:

Collaboration diagram for ant::calibration::gui::PeakingFitFunction:

Public Member Functions
	PeakingFitFunction ()

virtual double	GetPeakPosition () const =0
	Get the Position of the peak. More...

virtual double	GetPeakWidth () const =0
	Get the Peak Width. More...

virtual double	SignalToBackground (const double x) const
	Signal To Background. More...

virtual bool	EndsMatch (const double relative_epsilon) const
	Check if Background and Total function have the same value at the range borders. More...

Public Member Functions inherited from ant::calibration::gui::FitFunction
virtual	~FitFunction ()

virtual void	Draw ()=0

knoblist_t &	GetKnobs ()

virtual void	Fit (TH1 *hist)=0

virtual void	FitSignal (TH1 *)

virtual void	FitBackground (TH1 *)

void	SetAdditionalFitArgs (const std::string &args)

virtual void	SetDefaults (TH1 *hist)=0
	Set/Calculate default parameter values. The hist that will be fitted later is given to allow adaptions. More...

virtual void	SetRange (ant::interval< double > i)=0

virtual ant::interval< double >	GetRange () const =0

virtual void	Sync ()

virtual SavedState_t	Save () const =0
	Save the current fit parameters to a vector. Can then later be loaded again using Load() More...

virtual void	Load (const std::vector< double > &data)=0
	Load fit parameters from a vector. Useful to load previously used ones. More...

virtual double	Chi2NDF () const
	Get the reduced chi^2 (=chi^2/ndf) of last fit. More...

virtual double	Chi2 () const
	Get the Chi^2 of last fit. More...

virtual double	NDF () const
	Get the Number of degrees of freedom of last fit. More...

Additional Inherited Members
Public Types inherited from ant::calibration::gui::FitFunction
using	knoblist_t = std::list< std::unique_ptr< IndicatorKnob > >

using	SavedState_t = std::vector< double >

Public Attributes inherited from ant::calibration::gui::FitFunction
std::string	AdditionalFitArgs

Protected Member Functions inherited from ant::calibration::gui::FitFunction
template<typename T , typename ... Args_t>
void	AddKnob (Args_t &&... args)

void	doFit (TH1 *hist)

Static Protected Member Functions inherited from ant::calibration::gui::FitFunction
static ant::interval< double >	getRange (const TF1 *func)

static void	setRange (TF1 *func, const ant::interval< double > &i)

static void	saveTF1 (const TF1 *func, SavedState_t &out)

static void	loadTF1 (SavedState_t::const_iterator &data_pos, TF1 *func)

Protected Attributes inherited from ant::calibration::gui::FitFunction
TF1 *	func = nullptr

knoblist_t	knobs

Detailed Description

Fit functions describing peak shapes, like Gaus or Lorentz with optional background function.

Constructor & Destructor Documentation

◆ PeakingFitFunction()

PeakingFitFunction::PeakingFitFunction ( )

Member Function Documentation

◆ EndsMatch()

bool PeakingFitFunction::EndsMatch ( const double relative_epsilon ) const

virtual

Check if Background and Total function have the same value at the range borders.

Parameters

relative_epsilon maximum allowed relative difference (total/background)

Returns: true if functions are equal withing limits at the range borders

◆ GetPeakPosition()

virtual double ant::calibration::gui::PeakingFitFunction::GetPeakPosition ( ) const

pure virtual

Get the Position of the peak.

Returns: x_max

Implemented in ant::calibration::gui::FitLandauExpo, ant::calibration::gui::FitWeibullLandauPol1, ant::calibration::gui::FitGausexpo, ant::calibration::gui::FitGausPol0, ant::calibration::gui::FitLandau, ant::calibration::gui::FitLandauPol0, ant::calibration::gui::FitGausPol1, ant::calibration::gui::FitGausPol3, and ant::calibration::gui::FitGaus.

◆ GetPeakWidth()

virtual double ant::calibration::gui::PeakingFitFunction::GetPeakWidth ( ) const

pure virtual

Get the Peak Width.

Returns: width

Implemented in ant::calibration::gui::FitLandauExpo, ant::calibration::gui::FitWeibullLandauPol1, ant::calibration::gui::FitGausexpo, ant::calibration::gui::FitGausPol0, ant::calibration::gui::FitLandau, ant::calibration::gui::FitLandauPol0, ant::calibration::gui::FitGausPol1, ant::calibration::gui::FitGausPol3, and ant::calibration::gui::FitGaus.

◆ SignalToBackground()

double PeakingFitFunction::SignalToBackground ( const double x ) const

virtual

Signal To Background.

Parameters

x	Position to evaluate

Returns: (Signal + Background) / (Signal - Background)

Reimplemented in ant::calibration::gui::FitLandauExpo, ant::calibration::gui::FitWeibullLandauPol1, ant::calibration::gui::FitGausPol0, ant::calibration::gui::FitGausPol1, and ant::calibration::gui::FitGausPol3.

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

src/calibration/fitfunctions/FitFunction.h
src/calibration/fitfunctions/FitFunction.cc

Public Member Functions

Additional Inherited Members