laura is hosted by Hepforge, IPPP Durham
Laura++  v3r0
A maximum likelihood fitting package for performing Dalitz-plot analysis.

The abstract interface to the fitter. More...

#include <LauAbsFitter.hh>

Inheritance diagram for LauAbsFitter:
LauMinuit

Public Member Functions

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

Protected Member Functions

 LauAbsFitter ()
 Constructor. More...
 

Private Member Functions

 LauAbsFitter (const LauAbsFitter &)
 Copy constructor - private and not implemented. More...
 
LauAbsFitteroperator= (const LauAbsFitter &rhs)
 Copy assignment operator - private and not implemented. More...
 
 ClassDef (LauAbsFitter, 0)
 

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 35 of file LauAbsFitter.hh.

Constructor & Destructor Documentation

virtual LauAbsFitter::~LauAbsFitter ( )
inlinevirtual

Destructor.

Definition at line 39 of file LauAbsFitter.hh.

LauAbsFitter::LauAbsFitter ( )
inlineprotected

Constructor.

Definition at line 108 of file LauAbsFitter.hh.

LauAbsFitter::LauAbsFitter ( const LauAbsFitter )
private

Copy constructor - private and not implemented.

Member Function Documentation

LauAbsFitter::ClassDef ( LauAbsFitter  ,
 
)
private
virtual const TMatrixD& LauAbsFitter::covarianceMatrix ( ) const
pure virtual

Retrieve the fit covariance matrix.

Implemented in LauMinuit.

virtual void LauAbsFitter::fixFirstStageParameters ( )
pure virtual

Fix parameters marked as "first stage".

Implemented in LauMinuit.

virtual void LauAbsFitter::fixSecondStageParameters ( )
pure virtual

Fix parameters marked as "second stage".

Implemented in LauMinuit.

virtual LauFitObject* LauAbsFitter::getFitObject ( )
pure virtual

Get the object that controls the calculation of the likelihood.

Implemented in LauMinuit.

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

Initialise the fitter, setting the information on the parameters.

Parameters
[in]fitObjthe object that controls the likelihood calculation
[in]parametersthe list of parameters of the fit

Implemented in LauMinuit.

virtual std::pair<Int_t,Double_t> 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.

virtual UInt_t LauAbsFitter::nFreeParameters ( ) const
pure virtual

Get the number of floating fit parameters.

Implemented in LauMinuit.

virtual UInt_t LauAbsFitter::nParameters ( ) const
pure virtual

Get the total number of fit parameters.

Implemented in LauMinuit.

LauAbsFitter& LauAbsFitter::operator= ( const LauAbsFitter rhs)
private

Copy assignment operator - private and not implemented.

virtual void LauAbsFitter::releaseFirstStageParameters ( )
pure virtual

Release parameters marked as "first stage".

Implemented in LauMinuit.

virtual void LauAbsFitter::releaseSecondStageParameters ( )
pure virtual

Release parameters marked as "second stage".

Implemented in LauMinuit.

virtual Bool_t LauAbsFitter::twoStageFit ( ) const
pure virtual

Determine whether the two-stage fit is enabled.

Implemented in LauMinuit.

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]doTwoStageFitboolean specifying whether or not the two-stage fit should be enabled

Implemented in LauMinuit.

virtual void LauAbsFitter::updateParameters ( )
pure virtual

Update the values and errors of the parameters based on the fit minimum.

Implemented in LauMinuit.

virtual Bool_t LauAbsFitter::useAsymmFitErrors ( ) const
pure virtual

Determine whether calculation of asymmetric errors is enabled.

Implemented in LauMinuit.

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]useAsymmErrorsboolean 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: