laura is hosted by Hepforge, IPPP Durham
Laura++  v2r0
A maximum likelihood fitting package for performing Dalitz-plot analysis.
LauSimpleFitModel.hh
Go to the documentation of this file.
1 
2 // Copyright University of Warwick 2004 - 2013.
3 // Distributed under the Boost Software License, Version 1.0.
4 // (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
5 
6 // Authors:
7 // Thomas Latham
8 // John Back
9 // Paul Harrison
10 
23 #ifndef LAU_SIMPLE_FIT_MODEL
24 #define LAU_SIMPLE_FIT_MODEL
25 
26 #include <vector>
27 
28 #include "TString.h"
29 
30 #include "LauAbsFitModel.hh"
31 #include "LauParameter.hh"
32 
33 class TH2;
34 class LauAbsBkgndDPModel;
35 class LauAbsCoeffSet;
36 class LauAbsDPDynamics;
37 class LauAbsPdf;
38 class LauEffModel;
39 class LauEmbeddedData;
40 class LauKinematics;
41 class LauScfMap;
42 
43 
45 
46  public:
48 
51  explicit LauSimpleFitModel(LauAbsDPDynamics* sigDPModel);
52 
54  virtual ~LauSimpleFitModel();
55 
57 
60  virtual void setNSigEvents(LauParameter* nSigEvents);
61 
63 
68  virtual void setNBkgndEvents(LauParameter* nBkgndEvents);
69 
71 
75  void setBkgndDPModel(const TString& bkgndClass, LauAbsBkgndDPModel* bkgndModel);
76 
78 
87  void splitSignalComponent( const TH2* dpHisto, Bool_t upperHalf = kFALSE, LauScfMap* scfMap = 0 );
88 
90 
97  void splitSignalComponent( Double_t scfFrac, Bool_t fixed );
98 
100  Bool_t useSCF() const { return useSCF_; }
101 
103  Bool_t useSCFHist() const { return useSCFHist_; }
104 
106  Bool_t smearSCFDP() const { return (scfMap_ != 0); }
107 
109 
112  void setSignalPdf(LauAbsPdf* pdf);
113 
115 
118  void setSCFPdf(LauAbsPdf* pdf);
119 
121 
125  void setBkgndPdf(const TString& bkgndClass, LauAbsPdf* pdf);
126 
128 
135  void embedSignal(const TString& fileName, const TString& treeName,
136  Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment = kFALSE,
137  Bool_t useReweighting = kFALSE);
138 
140 
147  void embedBkgnd(const TString& bkgndClass, const TString& fileName, const TString& treeName,
148  Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment = kFALSE);
149 
151 
154  virtual void setAmpCoeffSet(LauAbsCoeffSet* coeffSet);
155 
157 
161  virtual void weightEvents( const TString& dataFileName, const TString& dataTreeName );
162 
163  protected:
165  typedef std::map< TString, std::pair<Int_t,Double_t> > LauGenInfo;
166 
168  typedef std::vector<LauAbsBkgndDPModel*> LauBkgndDPModelList;
169 
171  typedef std::vector<LauPdfList> LauBkgndPdfsList;
172 
174  typedef std::vector<LauParameter*> LauBkgndYieldList;
175 
177  typedef std::vector<LauEmbeddedData*> LauBkgndEmbDataList;
178 
180  typedef std::vector<Bool_t> LauBkgndReuseEventsList;
181 
183  virtual void initialise();
184 
186  virtual void initialiseDPModels();
187 
189  virtual void updateCoeffs();
190 
192  virtual Bool_t genExpt();
193 
196  virtual void propagateParUpdates();
197 
199  virtual void cacheInputFitVars();
200 
202  virtual void checkInitFitParams();
203 
205 
208  virtual void finaliseFitResults(const TString& tablePrefixName);
209 
211 
214  virtual void printFitFractions(std::ostream& output);
215 
217 
220  virtual void writeOutTable(const TString& outputFile);
221 
223  virtual void storePerEvtLlhds();
224 
225  // Methods to do with calculating the likelihood functions
226  // and manipulating the fitting parameters.
228 
231  virtual Double_t getTotEvtLikelihood(UInt_t iEvt);
232 
234 
237  virtual void getEvtDPLikelihood(UInt_t iEvt);
238 
240 
243  virtual Double_t getEvtSCFDPLikelihood(UInt_t iEvt);
244 
246 
249  virtual void getEvtExtraLikelihoods(UInt_t iEvt);
250 
252 
255  virtual Double_t getEventSum() const;
256 
258  void setSignalDPParameters();
259 
261  void setExtraPdfParameters();
262 
264  void setFitNEvents();
265 
267  void setExtraNtupleVars();
268 
270  void randomiseInitFitPars();
271 
273  virtual void setupBkgndVectors();
274 
277 
279  Bool_t generateSignalEvent();
280 
282 
285  Bool_t generateBkgndEvent(UInt_t bkgndID);
286 
288  void setupGenNtupleBranches();
289 
291  void setDPBranchValues();
292 
294 
298  void generateExtraPdfValues(LauPdfList* extraPdfs, LauEmbeddedData* embeddedData);
299 
301 
305  void addSPlotNtupleBranches(const LauPdfList* extraPdfs, const TString& prefix);
306 
308 
313  Double_t setSPlotNtupleBranchValues(LauPdfList* extraPdfs, const TString& prefix, UInt_t iEvt);
314 
316  void updateSigEvents();
317 
319  virtual void setupSPlotNtupleBranches();
320 
322  virtual LauSPlot::NameSet variableNames() const;
323 
325  virtual LauSPlot::NumbMap freeSpeciesNames() const;
326 
328  virtual LauSPlot::NumbMap fixdSpeciesNames() const;
329 
331  virtual LauSPlot::TwoDMap twodimPDFs() const;
332 
334  virtual Bool_t splitSignal() const {return this->useSCF();}
335 
337  virtual Bool_t scfDPSmear() const {return (scfMap_ != 0);}
338 
345 
348  void appendBinCentres( LauFitDataTree* inputData );
349 
350  private:
353 
356 
359 
362 
365 
368 
370  Bool_t usingBkgnd_;
371 
373  UInt_t nSigComp_;
374 
376  UInt_t nSigDPPar_;
377 
379  UInt_t nExtraPdfPar_;
380 
382  UInt_t nNormPar_;
383 
385  std::vector<LauAbsCoeffSet*> coeffPars_;
386 
389 
392 
395 
398 
401 
403  Bool_t useSCF_;
404 
406  Bool_t useSCFHist_;
407 
410 
413 
416 
418  std::vector<Double_t> recoSCFFracs_;
419 
421  std::vector<Double_t> fakeSCFFracs_;
422 
424  std::vector<Double_t> recoJacobians_;
425 
427  std::vector<Double_t> fakeJacobians_;
428 
431 
433  std::vector<LauComplex> coeffs_;
434 
435  // Embedding SP events
438 
441 
443  Bool_t reuseSignal_;
444 
447 
450 
452  Double_t sigDPLike_;
453 
455  Double_t scfDPLike_;
456 
458  std::vector<Double_t> bkgndDPLike_;
459 
461  Double_t sigExtraLike_;
462 
464  Double_t scfExtraLike_;
465 
467  std::vector<Double_t> bkgndExtraLike_;
468 
470  Double_t sigTotalLike_;
471 
473  Double_t scfTotalLike_;
474 
476  std::vector<Double_t> bkgndTotalLike_;
477 
478  ClassDef(LauSimpleFitModel,0) // Total fit/ToyMC model
479 
480 };
481 
482 #endif
void setSignalPdf(LauAbsPdf *pdf)
Set the signal PDF for a given variable.
LauAbsDPDynamics * sigDPModel_
The signal Dalitz plot model.
void setBkgndDPModel(const TString &bkgndClass, LauAbsBkgndDPModel *bkgndModel)
Set the background DP models.
Bool_t reuseSignal_
Boolean to reuse signal events.
Bool_t useSCFHist() const
Determine whether the SCF fraction is DP-dependent.
void setDPBranchValues()
Store all of the DP information.
Class for defining the abstract interface for signal Dalitz plot dynamics.
The abstract interface for a background Dalitz plot model.
LauParameter meanEff_
The mean efficiency.
Double_t sigExtraLike_
Signal likelihood from extra PDFs.
Bool_t useSCF() const
Determine whether we are splitting the signal into TM and SCF parts.
Double_t sigDPLike_
Signal likelihood value.
void randomiseInitFitPars()
Randomise the initial fit parameters.
LauSimpleFitModel(LauAbsDPDynamics *sigDPModel)
Constructor.
LauEffModel * scfFracHist_
The histogram giving the DP-dependence of the SCF fraction.
virtual Double_t getTotEvtLikelihood(UInt_t iEvt)
Get the total likelihood for each event.
File containing declaration of LauAbsFitModel class.
std::vector< Double_t > recoJacobians_
The cached values of the sqDP jacobians for each event.
void generateExtraPdfValues(LauPdfList *extraPdfs, LauEmbeddedData *embeddedData)
Generate from the extra PDFs.
virtual void initialise()
Initialise the fit.
std::map< TString, std::pair< Int_t, Double_t > > LauGenInfo
Define a map to be used to store a category name and numbers.
Bool_t smearSCFDP() const
Determine if we are smearing the SCF DP PDF.
virtual void setNBkgndEvents(LauParameter *nBkgndEvents)
Set the background event yield(s)
virtual void weightEvents(const TString &dataFileName, const TString &dataTreeName)
Weight events based on the DP model.
virtual void setAmpCoeffSet(LauAbsCoeffSet *coeffSet)
Set the DP amplitude coefficients.
std::multimap< TString, std::pair< TString, TString > > TwoDMap
Type to associate the name of the species that have 2D PDFs with the names of the two variables invol...
Definition: LauSPlot.hh:68
UInt_t nExtraPdfPar_
Number of extra PDF parameters.
Double_t scfDPLike_
SCF likelihood value.
std::vector< LauPdfList > LauBkgndPdfsList
Typedef for a vector of background PDFs.
virtual void finaliseFitResults(const TString &tablePrefixName)
Get the fit results and store them.
virtual void propagateParUpdates()
Bool_t useSCFHist_
Is the SCF fraction DP-dependent.
LauBkgndReuseEventsList reuseBkgnd_
Vector of booleans to reuse background events.
virtual Bool_t scfDPSmear() const
Check if the mis-reconstructed signal is to be smeared in the DP.
std::vector< std::vector< LauParameter > > LauParArray
Type to define an array of parameters.
void setBkgndPdf(const TString &bkgndClass, LauAbsPdf *pdf)
Set the background PDF.
std::vector< LauAbsPdf * > LauPdfList
List of Pdfs.
virtual void updateCoeffs()
Update the coefficients.
virtual void getEvtDPLikelihood(UInt_t iEvt)
Calculate the signal and background likelihoods for the DP for a given event.
LauEmbeddedData * signalTree_
The signal event tree.
void setSCFPdf(LauAbsPdf *pdf)
Set the SCF PDF for a given variable.
virtual void setNSigEvents(LauParameter *nSigEvents)
Set the signal event yield.
Bool_t useReweighting_
Boolean to use reweighting.
virtual void printFitFractions(std::ostream &output)
Print the fit fractions, total DP rate and mean efficiency.
void addSPlotNtupleBranches(const LauPdfList *extraPdfs, const TString &prefix)
Add sPlot branches for the extra PDFs.
virtual LauSPlot::TwoDMap twodimPDFs() const
Returns the species and variables for all 2D PDFs in the fit.
std::vector< LauComplex > coeffs_
The complex coefficients.
std::vector< Double_t > bkgndExtraLike_
Background likelihood value(s) from extra PDFs.
LauBkgndYieldList bkgndEvents_
Background yield(s)
LauPdfList signalPdfs_
The signal PDFs.
void setExtraPdfParameters()
Set the fit parameters for the extra PDFs.
Bool_t generateBkgndEvent(UInt_t bkgndID)
Generate background event.
Double_t scfTotalLike_
Total SCF likelihood.
virtual Bool_t splitSignal() const
Check if the signal is split into well-reconstructed and mis-reconstructed types. ...
void updateSigEvents()
Update the signal events after Minuit sets background parameters.
virtual LauSPlot::NumbMap fixdSpeciesNames() const
Returns the names and yields of species that are fixed in the fit.
LauParameter dpRate_
The average DP rate.
std::vector< Double_t > bkgndDPLike_
Background likelihood value(s)
UInt_t nNormPar_
Number of parameters.
void setupGenNtupleBranches()
Setup the required ntuple branches.
void appendBinCentres(LauFitDataTree *inputData)
virtual void cacheInputFitVars()
Read in the input fit data variables, e.g. m13Sq and m23Sq.
Abstract interface to the fitting and toy MC model.
void setSignalDPParameters()
Set the fit parameters for the DP model.
std::vector< LauAbsCoeffSet * > coeffPars_
Magnitudes and Phases.
virtual LauSPlot::NumbMap freeSpeciesNames() const
Returns the names and yields of species that are free in the fit.
virtual LauSPlot::NameSet variableNames() const
Returns the names of all variables in the fit.
File containing declaration of LauParameter class.
virtual void getEvtExtraLikelihoods(UInt_t iEvt)
Determine the signal and background likelihood for the extra variables for a given event...
LauBkgndPdfsList bkgndPdfs_
The background PDFs.
std::vector< LauParameter * > LauBkgndYieldList
Typedef for a vector of background yields.
std::map< TString, Double_t > NumbMap
Type to associate a category name with a double precision number, e.g. a yield or PDF value for a giv...
Definition: LauSPlot.hh:62
std::vector< LauAbsBkgndDPModel * > LauBkgndDPModelList
Typedef for a vector of background DP models.
Bool_t useSCF_
Is the signal split into TM and SCF.
void splitSignalComponent(const TH2 *dpHisto, Bool_t upperHalf=kFALSE, LauScfMap *scfMap=0)
Split the signal component into well-reconstructed and mis-reconstructed parts.
virtual void setupBkgndVectors()
Define the length of the background vectors.
LauGenInfo eventsToGenerate()
Determine the number of events to generate for each hypothesis.
Class for defining the abstract interface for complex coefficient classes.
std::vector< Double_t > fakeJacobians_
The cached values of the sqDP jacobians for each true bin.
void embedSignal(const TString &fileName, const TString &treeName, Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment=kFALSE, Bool_t useReweighting=kFALSE)
Embed full simulation events for the signal, rather than generating toy from the PDFs.
std::vector< Double_t > bkgndTotalLike_
Total background likelihood(s)
Class for defining the fit parameter objects.
Definition: LauParameter.hh:32
LauBkgndDPModelList bkgndDPModels_
The background Dalitz Plot model.
Class to store the data for embedding in toy experiments.
LauScfMap * scfMap_
The smearing matrix for the SCF DP PDF.
UInt_t nSigComp_
Number of signal components.
virtual Double_t getEvtSCFDPLikelihood(UInt_t iEvt)
Calculate the SCF likelihood for the DP for a given event.
Double_t setSPlotNtupleBranchValues(LauPdfList *extraPdfs, const TString &prefix, UInt_t iEvt)
Set the branches for the sPlot ntuple with extra PDFs.
virtual void writeOutTable(const TString &outputFile)
Write the fit results in latex table format.
Define a Dalitz plot according to the isobar model.
LauPdfList scfPdfs_
The SCF PDFs.
Class that implements the efficiency description across the signal Dalitz plot.
Definition: LauEffModel.hh:37
Bool_t usingBkgnd_
Background boolean.
LauParameter * signalEvents_
Signal yield.
std::vector< LauEmbeddedData * > LauBkgndEmbDataList
Typedef for a vector of embedded data objects.
std::vector< Double_t > recoSCFFracs_
The cached values of the SCF fraction for each event.
void embedBkgnd(const TString &bkgndClass, const TString &fileName, const TString &treeName, Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment=kFALSE)
Embed full simulation events for the given background class, rather than generating toy from the PDFs...
Double_t scfExtraLike_
SCF likelihood from extra PDFs.
UInt_t nSigDPPar_
Number of signal DP parameters.
std::vector< Double_t > fakeSCFFracs_
The cached values of the SCF fraction for each bin centre.
LauParArray fitFrac_
Fit fractions.
Double_t sigTotalLike_
Total signal likelihood.
Class for representing the 4D smearing matrix for mis-reconstructed signal (self cross feed) ...
Definition: LauScfMap.hh:29
LauParameter scfFrac_
The (global) SCF fraction parameter.
virtual ~LauSimpleFitModel()
Destructor.
Bool_t compareFitData_
Run choice variables.
Class for defining the abstract interface for PDF classes.
Definition: LauAbsPdf.hh:40
Class for calculating 3-body kinematic quantities.
virtual void setupSPlotNtupleBranches()
Add branches to store experiment number and the event number within the experiment.
virtual void checkInitFitParams()
Check the initial fit parameters.
void setExtraNtupleVars()
Set-up other parameters that are derived from the fit results, e.g. fit fractions.
virtual void storePerEvtLlhds()
Store the per event likelihood values.
std::vector< Bool_t > LauBkgndReuseEventsList
Typedef for a vector of booleans to flag if events are reused.
virtual Bool_t genExpt()
Toy MC generation and fitting overloaded functions.
void setFitNEvents()
Set the initial yields.
virtual Double_t getEventSum() const
Get the total number of events.
LauKinematics * kinematics_
The Dalitz plot kinematics object.
Class to store the input fit variables.
std::set< TString > NameSet
Type to store names, e.g. of the discriminating/control variables.
Definition: LauSPlot.hh:59
virtual void initialiseDPModels()
Initialise the signal DP model.
LauBkgndEmbDataList bkgndTree_
The background event tree.
Bool_t generateSignalEvent()
Generate signal event.