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

Class for defining a histogram-based background Dalitz plot model. More...

#include <LauBkgndDPModel.hh>

Inheritance diagram for LauBkgndDPModel:
LauAbsBkgndDPModel

Public Member Functions

 LauBkgndDPModel (LauDaughters *daughters, LauVetoes *vetoes)
 Constructor. More...
 
virtual ~LauBkgndDPModel ()
 Destructor. More...
 
void setBkgndHisto (const TH2 *histo, Bool_t useInterpolation, Bool_t fluctuateBins, Bool_t useUpperHalfOnly, Bool_t squareDP=kFALSE)
 Set background histogram. More...
 
void setBkgndSpline (const TH2 *histo, Bool_t fluctuateBins, Bool_t useUpperHalfOnly, Bool_t squareDP)
 Set the background histogram and generate a spline. More...
 
virtual void initialise ()
 Initialise the model. More...
 
virtual Bool_t generate ()
 Generate a toy MC event from the model. More...
 
virtual Double_t getUnNormValue (UInt_t iEvt)
 Get unnormalised likelihood for a given event. More...
 
virtual Double_t getPdfNorm () const
 Get PDF normalisation constant. More...
 
virtual Double_t getLikelihood (UInt_t iEvt)
 Get likelihood for a given event. More...
 
virtual void fillDataTree (const LauFitDataTree &fitDataTree)
 Cache the input data and (if appropriate) the per-event likelihood values. More...
 
- Public Member Functions inherited from LauAbsBkgndDPModel
virtual ~LauAbsBkgndDPModel ()
 Destructor. More...
 
const LauDaughtersgetDaughters () const
 Get the daughter particles. More...
 
LauDaughtersgetDaughters ()
 Get the daughter particles. More...
 
const LauKinematicsgetKinematics () const
 Get the Dalitz plot kinematics. More...
 
LauKinematicsgetKinematics ()
 Get the Dalitz plot kinematics. More...
 
const LauVetoesgetVetoes () const
 Get vetoes in the Dalitz plot. More...
 
LauVetoesgetVetoes ()
 Get vetoes in the Dalitz plot. More...
 

Protected Member Functions

Double_t calcHistValue (Double_t xVal, Double_t yVal)
 Calulate histogram value at a given point. More...
 
virtual void setDataEventNo (UInt_t iEvt)
 Set data event number. More...
 
- Protected Member Functions inherited from LauAbsBkgndDPModel
 LauAbsBkgndDPModel (LauDaughters *daughters, LauVetoes *vetoes)
 Constructor. More...
 

Private Attributes

Bool_t symmetricalDP_
 Flags whether the DP is symmetrical or not. More...
 
Bool_t squareDP_
 Flags whether or not to work in square DP coordinates. More...
 
Lau2DAbsDPPdfbgHistDPPdf_
 PDF of Dalitz plot background, from a 2D histogram. More...
 
std::vector< Double_t > bgData_
 Cached histogram values for each event. More...
 
Double_t curEvtHistVal_
 Histogram value for the current event. More...
 
Double_t maxPdfHeight_
 Maximum height of PDF. More...
 
Double_t pdfNorm_
 Normalisation of PDF. More...
 
Bool_t doneGenWarning_
 Boolean to indicate if the warning that there is no histogram has already been issued. More...
 
Bool_t lowBinWarningIssued_
 Flag to track whether a warning has been issued for bin values less than zero. More...
 

Detailed Description

Class for defining a histogram-based background Dalitz plot model.

Class for defining a histogram-based background Dalitz plot model

Definition at line 34 of file LauBkgndDPModel.hh.

Constructor & Destructor Documentation

LauBkgndDPModel::LauBkgndDPModel ( LauDaughters daughters,
LauVetoes vetoes 
)

Constructor.

Parameters
[in]daughtersthe daughters in the decay
[in]vetoesthe vetoes in the Datliz plot

Definition at line 36 of file LauBkgndDPModel.cc.

LauBkgndDPModel::~LauBkgndDPModel ( )
virtual

Destructor.

Definition at line 52 of file LauBkgndDPModel.cc.

Member Function Documentation

Double_t LauBkgndDPModel::calcHistValue ( Double_t  xVal,
Double_t  yVal 
)
protected

Calulate histogram value at a given point.

Parameters
[in]xValthe x-value
[in]yValthe y-value
Returns
the histogram value

Definition at line 91 of file LauBkgndDPModel.cc.

void LauBkgndDPModel::fillDataTree ( const LauFitDataTree fitDataTree)
virtual

Cache the input data and (if appropriate) the per-event likelihood values.

Parameters
[in]fitDataTreethe input data

Implements LauAbsBkgndDPModel.

Definition at line 219 of file LauBkgndDPModel.cc.

Bool_t LauBkgndDPModel::generate ( )
virtual

Generate a toy MC event from the model.

Returns
success/failure flag

Implements LauAbsBkgndDPModel.

Definition at line 136 of file LauBkgndDPModel.cc.

Double_t LauBkgndDPModel::getLikelihood ( UInt_t  iEvt)
virtual

Get likelihood for a given event.

Parameters
[in]iEvtthe event number
Returns
the likelihood value

Implements LauAbsBkgndDPModel.

Definition at line 271 of file LauBkgndDPModel.cc.

virtual Double_t LauBkgndDPModel::getPdfNorm ( ) const
inlinevirtual

Get PDF normalisation constant.

Returns
the PDF normalisation constant

Implements LauAbsBkgndDPModel.

Definition at line 91 of file LauBkgndDPModel.hh.

Double_t LauBkgndDPModel::getUnNormValue ( UInt_t  iEvt)
virtual

Get unnormalised likelihood for a given event.

Parameters
[in]iEvtthe event number
Returns
the unnormalised likelihood value

Implements LauAbsBkgndDPModel.

Definition at line 264 of file LauBkgndDPModel.cc.

void LauBkgndDPModel::initialise ( )
virtual

Initialise the model.

Implements LauAbsBkgndDPModel.

Definition at line 132 of file LauBkgndDPModel.cc.

void LauBkgndDPModel::setBkgndHisto ( const TH2 *  histo,
Bool_t  useInterpolation,
Bool_t  fluctuateBins,
Bool_t  useUpperHalfOnly,
Bool_t  squareDP = kFALSE 
)

Set background histogram.

Parameters
[in]histothe 2D histogram describing the DP distribution
[in]useInterpolationboolean flag to determine whether linear interpolation between bins should be used or simply the raw bin values
[in]fluctuateBinsboolean flag to determine whether the bin contents should be fluctuated in accordance with their errors. The seed for the random number generator used to fluctuate the bins should first be set using LauRandom::setSeed.
[in]useUpperHalfOnlyboolean flag to determine whether, in the case of a symmetric DP, the histogram supplied only includes the upper half of the DP
[in]squareDPboolean flag to determine whether the supplied histogram is given in square DP coordinates

Definition at line 59 of file LauBkgndDPModel.cc.

void LauBkgndDPModel::setBkgndSpline ( const TH2 *  histo,
Bool_t  fluctuateBins,
Bool_t  useUpperHalfOnly,
Bool_t  squareDP 
)

Set the background histogram and generate a spline.

Parameters
[in]histothe 2D histogram describing the DP distribution
[in]fluctuateBinsboolean flag to determine whether the bin contents should be fluctuated in accordance with their errors. The seed for the random number generator used to fluctuate the bins should first be set using LauRandom::setSeed.
[in]useUpperHalfOnlyboolean flag to determine whether, in the case of a symmetric DP, the histogram supplied only includes the upper half of the DP
[in]squareDPboolean flag to determine whether the supplied histogram is given in square DP coordinates

Definition at line 75 of file LauBkgndDPModel.cc.

void LauBkgndDPModel::setDataEventNo ( UInt_t  iEvt)
protectedvirtual

Set data event number.

Parameters
[in]iEvtthe event number

Implements LauAbsBkgndDPModel.

Definition at line 279 of file LauBkgndDPModel.cc.

Member Data Documentation

std::vector<Double_t> LauBkgndDPModel::bgData_
private

Cached histogram values for each event.

Definition at line 132 of file LauBkgndDPModel.hh.

Lau2DAbsDPPdf* LauBkgndDPModel::bgHistDPPdf_
private

PDF of Dalitz plot background, from a 2D histogram.

Definition at line 129 of file LauBkgndDPModel.hh.

Double_t LauBkgndDPModel::curEvtHistVal_
private

Histogram value for the current event.

Definition at line 135 of file LauBkgndDPModel.hh.

Bool_t LauBkgndDPModel::doneGenWarning_
private

Boolean to indicate if the warning that there is no histogram has already been issued.

Definition at line 144 of file LauBkgndDPModel.hh.

Bool_t LauBkgndDPModel::lowBinWarningIssued_
mutableprivate

Flag to track whether a warning has been issued for bin values less than zero.

Definition at line 147 of file LauBkgndDPModel.hh.

Double_t LauBkgndDPModel::maxPdfHeight_
private

Maximum height of PDF.

Definition at line 138 of file LauBkgndDPModel.hh.

Double_t LauBkgndDPModel::pdfNorm_
private

Normalisation of PDF.

Definition at line 141 of file LauBkgndDPModel.hh.

Bool_t LauBkgndDPModel::squareDP_
private

Flags whether or not to work in square DP coordinates.

Definition at line 126 of file LauBkgndDPModel.hh.

Bool_t LauBkgndDPModel::symmetricalDP_
private

Flags whether the DP is symmetrical or not.

Definition at line 123 of file LauBkgndDPModel.hh.


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