LauAbsFitter Class Reference

The abstract interface to the fitter. More...

#include <LauAbsFitter.hh>

Inheritance diagram for LauAbsFitter:

Classes
struct	FitStatus
	Struct to store fit status information. More...

Public Member Functions
virtual	~LauAbsFitter ()=default
	Destructor.
virtual void	initialise (LauFitObject *fitObj, const std::vector< LauParameter * > &parameters)=0
	Initialise the fitter, setting the information on the parameters. More...
virtual LauFitObject *	getFitObject ()=0
	Get the object that controls the calculation of the likelihood.
virtual UInt_t	nParameters () const =0
	Get the total number of fit parameters.
virtual UInt_t	nFreeParameters () const =0
	Get the number of floating fit parameters.
virtual Bool_t	twoStageFit () const =0
	Determine whether the two-stage fit is enabled.
virtual void	twoStageFit (Bool_t doTwoStageFit)=0
	Turn on or off the two stage fit. More...
virtual Bool_t	useAsymmFitErrors () const =0
	Determine whether calculation of asymmetric errors is enabled.
virtual void	useAsymmFitErrors (Bool_t useAsymmErrors)=0
	Turn on or off the computation of asymmetric errors (e.g. MINOS routine in Minuit) More...
virtual const FitStatus &	minimise ()=0
	Perform the minimisation of the fit function. More...
virtual void	fixSecondStageParameters ()=0
	Fix parameters marked as "second stage".
virtual void	releaseSecondStageParameters ()=0
	Release parameters marked as "second stage".
virtual void	updateParameters ()=0
	Update the values and errors of the parameters based on the fit minimum.
virtual const TMatrixD &	covarianceMatrix () const =0
	Retrieve the fit covariance matrix.

Protected Member Functions
	LauAbsFitter ()=default
	Constructor.

Private Member Functions
	LauAbsFitter (const LauAbsFitter &)=delete
	Copy constructor - private and not implemented.
	LauAbsFitter (LauAbsFitter &&)=delete
	Move constructor - private and not implemented.
LauAbsFitter &	operator= (const LauAbsFitter &rhs)=delete
	Copy assignment operator - private and not implemented.
LauAbsFitter &	operator= (LauAbsFitter &&rhs)=delete
	Move assignment operator - private and not implemented.

Detailed Description

The abstract interface to the fitter.

The abstract interface to the fitter. Concrete implementations provide the singleton interface with a particular fitter, e.g. Minuit.

Definition at line 47 of file LauAbsFitter.hh.

Member Function Documentation

initialise()

virtual void LauAbsFitter::initialise ( LauFitObject *  fitObj, const std::vector< LauParameter * > &  parameters  )

pure virtual

Initialise the fitter, setting the information on the parameters.

Parameters

[in]	fitObj	the object that controls the likelihood calculation
[in]	parameters	the list of parameters of the fit

Implemented in LauMinuit.

minimise()

virtual const FitStatus& LauAbsFitter::minimise ( )

pure virtual

Perform the minimisation of the fit function.

Returns

the status code of the fit and the minimised value

Implemented in LauMinuit.

twoStageFit()

virtual void LauAbsFitter::twoStageFit ( Bool_t  doTwoStageFit )

pure virtual

Turn on or off the two stage fit.

The two-stage fit allows certain parameters to be fixed in one stage and floated in another stage of the fit. Can be used, for example, in a CP fit where the CP-parameters are fixed to zero in the first stage (while the CP-average parameters are determined), then floated in the second.

Parameters

[in]

doTwoStageFit

boolean specifying whether or not the two-stage fit should be enabled

Implemented in LauMinuit.

useAsymmFitErrors()

virtual void LauAbsFitter::useAsymmFitErrors ( Bool_t  useAsymmErrors )

pure virtual

Turn on or off the computation of asymmetric errors (e.g. MINOS routine in Minuit)

Parameters

[in]

useAsymmErrors

boolean specifying whether or not the computation of asymmetric errors is enabled

Implemented in LauMinuit.

---

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

• /home/epp/phsdba/Development/Laura++/master-dev/laura/inc/LauAbsFitter.hh