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

The interface to the Minuit fitter. More...

#include <LauMinuit.hh>

Inheritance diagram for LauMinuit:
LauAbsFitter

Public Member Functions

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

Private Member Functions

 LauMinuit (Int_t maxPar=100)
 Constructor. More...
 
 LauMinuit (const LauMinuit &)
 Copy constructor - private and not implemented. More...
 
LauMinuitoperator= (const LauMinuit &rhs)
 Copy assignment operator - private and not implemented. More...
 
 ClassDef (LauMinuit, 0)
 

Private Attributes

TVirtualFitter * minuit_
 The interface to Minuit. More...
 
const UInt_t maxPar_
 The maximum number of parameters. More...
 
std::vector< LauParameter * > params_
 The fit parameters. More...
 
UInt_t nParams_
 The total number of parameters. More...
 
UInt_t nFreeParams_
 The number of free parameters. More...
 
Bool_t twoStageFit_
 Option to perform a two stage fit. More...
 
Bool_t useAsymmFitErrors_
 Option to use asymmetric errors. More...
 
Int_t fitStatus_
 The status of the fit. More...
 
Double_t NLL_
 The negative log-likelihood. More...
 
TMatrixD covMatrix_
 The covariance matrix. More...
 

Friends

class LauFitter
 Allow the factory class to access private methods. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LauAbsFitter
 LauAbsFitter ()
 Constructor. More...
 

Detailed Description

The interface to the Minuit fitter.

The singleton interface to the Minuit fitter.

Definition at line 36 of file LauMinuit.hh.

Constructor & Destructor Documentation

LauMinuit::~LauMinuit ( )
virtual

Destructor.

Definition at line 50 of file LauMinuit.cc.

LauMinuit::LauMinuit ( Int_t  maxPar = 100)
explicitprivate

Constructor.

Definition at line 36 of file LauMinuit.cc.

LauMinuit::LauMinuit ( const LauMinuit )
private

Copy constructor - private and not implemented.

Member Function Documentation

LauMinuit::ClassDef ( LauMinuit  ,
 
)
private
virtual const TMatrixD& LauMinuit::covarianceMatrix ( ) const
inlinevirtual

Retrieve the fit covariance matrix.

Implements LauAbsFitter.

Definition at line 105 of file LauMinuit.hh.

void LauMinuit::fixFirstStageParameters ( )
virtual

Fix parameters marked as "first stage".

Implements LauAbsFitter.

Definition at line 212 of file LauMinuit.cc.

void LauMinuit::fixSecondStageParameters ( )
virtual

Fix parameters marked as "second stage".

Implements LauAbsFitter.

Definition at line 238 of file LauMinuit.cc.

LauFitObject * LauMinuit::getFitObject ( )
virtual

Get the object that controls the calculation of the likelihood.

Implements LauAbsFitter.

Definition at line 124 of file LauMinuit.cc.

void LauMinuit::initialise ( LauFitObject fitObj,
const std::vector< LauParameter * > &  parameters 
)
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

Implements LauAbsFitter.

Definition at line 54 of file LauMinuit.cc.

std::pair< Int_t, Double_t > LauMinuit::minimise ( )
virtual

Perform the minimisation of the fit function.

Returns
the status code of the fit and the minimised value

Implements LauAbsFitter.

Definition at line 129 of file LauMinuit.cc.

virtual UInt_t LauMinuit::nFreeParameters ( ) const
inlinevirtual

Get the number of floating fit parameters.

Implements LauAbsFitter.

Definition at line 56 of file LauMinuit.hh.

virtual UInt_t LauMinuit::nParameters ( ) const
inlinevirtual

Get the total number of fit parameters.

Implements LauAbsFitter.

Definition at line 53 of file LauMinuit.hh.

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

Copy assignment operator - private and not implemented.

void LauMinuit::releaseFirstStageParameters ( )
virtual

Release parameters marked as "first stage".

Implements LauAbsFitter.

Definition at line 225 of file LauMinuit.cc.

void LauMinuit::releaseSecondStageParameters ( )
virtual

Release parameters marked as "second stage".

Implements LauAbsFitter.

Definition at line 251 of file LauMinuit.cc.

virtual Bool_t LauMinuit::twoStageFit ( ) const
inlinevirtual

Determine whether the two-stage fit is enabled.

Implements LauAbsFitter.

Definition at line 59 of file LauMinuit.hh.

virtual void LauMinuit::twoStageFit ( Bool_t  doTwoStageFit)
inlinevirtual

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

Implements LauAbsFitter.

Definition at line 72 of file LauMinuit.hh.

void LauMinuit::updateParameters ( )
virtual

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

Implements LauAbsFitter.

Definition at line 264 of file LauMinuit.cc.

virtual Bool_t LauMinuit::useAsymmFitErrors ( ) const
inlinevirtual

Determine whether calculation of asymmetric errors is enabled.

Implements LauAbsFitter.

Definition at line 75 of file LauMinuit.hh.

virtual void LauMinuit::useAsymmFitErrors ( Bool_t  useAsymmErrors)
inlinevirtual

Turn on or off the computation of asymmetric errors (i.e. the MINOS routine)

Parameters
[in]useAsymmErrorsboolean specifying whether or not the computation of asymmetric errors is enabled

Implements LauAbsFitter.

Definition at line 81 of file LauMinuit.hh.

Friends And Related Function Documentation

friend class LauFitter
friend

Allow the factory class to access private methods.

Definition at line 110 of file LauMinuit.hh.

Member Data Documentation

TMatrixD LauMinuit::covMatrix_
private

The covariance matrix.

Definition at line 149 of file LauMinuit.hh.

Int_t LauMinuit::fitStatus_
private

The status of the fit.

Definition at line 143 of file LauMinuit.hh.

const UInt_t LauMinuit::maxPar_
private

The maximum number of parameters.

Definition at line 125 of file LauMinuit.hh.

TVirtualFitter* LauMinuit::minuit_
private

The interface to Minuit.

Definition at line 122 of file LauMinuit.hh.

UInt_t LauMinuit::nFreeParams_
private

The number of free parameters.

Definition at line 134 of file LauMinuit.hh.

Double_t LauMinuit::NLL_
private

The negative log-likelihood.

Definition at line 146 of file LauMinuit.hh.

UInt_t LauMinuit::nParams_
private

The total number of parameters.

Definition at line 131 of file LauMinuit.hh.

std::vector<LauParameter*> LauMinuit::params_
private

The fit parameters.

Definition at line 128 of file LauMinuit.hh.

Bool_t LauMinuit::twoStageFit_
private

Option to perform a two stage fit.

Definition at line 137 of file LauMinuit.hh.

Bool_t LauMinuit::useAsymmFitErrors_
private

Option to use asymmetric errors.

Definition at line 140 of file LauMinuit.hh.


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