laura is hosted by Hepforge, IPPP Durham
Laura++  v1r2
A maximum likelihood fitting package for performing Dalitz-plot analysis.
LauCPFitModel.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 
26 #ifndef LAU_CP_FIT_MODEL
27 #define LAU_CP_FIT_MODEL
28 
29 #include <vector>
30 
31 #include "TString.h"
32 
33 #include "LauAbsFitModel.hh"
34 #include "LauParameter.hh"
35 
36 class TH2;
37 class LauAbsBkgndDPModel;
38 class LauAbsCoeffSet;
39 class LauAbsDPDynamics;
40 class LauAbsPdf;
41 class LauEffModel;
42 class LauEmbeddedData;
43 class LauKinematics;
44 class LauScfMap;
45 
46 
47 class LauCPFitModel : public LauAbsFitModel {
48 
49  public:
51 
57  LauCPFitModel(LauAbsDPDynamics* negModel, LauAbsDPDynamics* posModel, Bool_t tagged = kTRUE, const TString& tagVarName = "charge");
58 
60  virtual ~LauCPFitModel();
61 
63 
66  virtual void setNSigEvents(LauParameter* nSigEvents);
67 
69 
74  virtual void setNSigEvents(LauParameter* nSigEvents, LauParameter* sigAsym, Bool_t forceAsym = kFALSE);
75 
77 
82  virtual void setNBkgndEvents(LauParameter* nBkgndEvents);
83 
85 
91  virtual void setNBkgndEvents(LauParameter* nBkgndEvents, LauParameter* bkgndAsym);
92 
94 
99  void setBkgndDPModels(const TString& bkgndClass, LauAbsBkgndDPModel* negModel, LauAbsBkgndDPModel* posModel);
100 
102 
111  void splitSignalComponent( const TH2* dpHisto, Bool_t upperHalf = kFALSE, LauScfMap* scfMap = 0 );
112 
114 
121  void splitSignalComponent( Double_t scfFrac, Bool_t fixed );
122 
124  Bool_t useSCF() const { return useSCF_; }
125 
127  Bool_t useSCFHist() const { return useSCFHist_; }
128 
130  Bool_t smearSCFDP() const { return (scfMap_ != 0); }
131 
132  // Set the DeltaE and mES models, i.e. give us the PDFs
134 
138  void setSignalPdfs(LauAbsPdf* negPdf, LauAbsPdf* posPdf);
139 
141 
145  void setSCFPdfs(LauAbsPdf* negPdf, LauAbsPdf* posPdf);
146 
148 
153  void setBkgndPdfs(const TString& bkgndClass, LauAbsPdf* negPdf, LauAbsPdf* posPdf);
154 
156 
163  void embedNegSignal(const TString& fileName, const TString& treeName,
164  Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment = kFALSE,
165  Bool_t useReweighting = kFALSE);
166 
168 
175  void embedNegBkgnd(const TString& bgClass, const TString& fileName, const TString& treeName,
176  Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment = kFALSE);
177 
179 
186  void embedPosSignal(const TString& fileName, const TString& treeName,
187  Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment = kFALSE,
188  Bool_t useReweighting = kFALSE);
189 
191 
198  void embedPosBkgnd(const TString& bgClass, const TString& fileName, const TString& treeName,
199  Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment = kFALSE);
200 
202 
205  void setAmpCoeffSet(LauAbsCoeffSet* coeffSet);
206 
208 
212  virtual void weightEvents( const TString& dataFileName, const TString& dataTreeName );
213 
214  protected:
216  typedef std::map< std::pair<TString,Int_t>, std::pair<Int_t,Double_t> > LauGenInfo;
217 
219  typedef std::vector<LauAbsBkgndDPModel*> LauBkgndDPModelList;
220 
222  typedef std::vector<LauPdfList> LauBkgndPdfsList;
223 
225  typedef std::vector<LauParameter*> LauBkgndYieldList;
226 
228  typedef std::vector<LauEmbeddedData*> LauBkgndEmbDataList;
229 
231  typedef std::vector<Bool_t> LauBkgndReuseEventsList;
232 
233 
235  virtual void initialise();
236 
238  virtual void initialiseDPModels();
239 
241  virtual void updateCoeffs();
242 
244  virtual Bool_t genExpt();
245 
248  virtual void propagateParUpdates();
249 
251  virtual void cacheInputFitVars();
252 
254  virtual void checkInitFitParams();
255 
257 
260  virtual void finaliseFitResults(const TString& tablePrefixName);
261 
263 
266  virtual void printFitFractions(std::ostream& output);
267 
269 
272  virtual void printAsymmetries(std::ostream& output);
273 
275 
278  virtual void writeOutTable(const TString& outputFile);
279 
281  virtual void storePerEvtLlhds();
282 
283  // Methods to do with calculating the likelihood functions
284  // and manipulating the fitting parameters.
286 
289  virtual Double_t getTotEvtLikelihood(UInt_t iEvt);
290 
292 
295  virtual void getEvtDPLikelihood(UInt_t iEvt);
296 
298 
301  virtual Double_t getEvtSCFDPLikelihood(UInt_t iEvt);
302 
304 
307  virtual void getEvtExtraLikelihoods(UInt_t iEvt);
308 
310 
313  virtual Double_t getEventSum() const;
314 
316  void setSignalDPParameters();
317 
319  void setExtraPdfParameters();
320 
322  void setFitNEvents();
323 
325  void setExtraNtupleVars();
326 
328  void randomiseInitFitPars();
329 
331 
334  void calcExtraFractions(Bool_t initValues = kFALSE);
335 
337 
340  void calcAsymmetries(Bool_t initValues = kFALSE);
341 
343  virtual void setupBkgndVectors();
344 
347 
349  Bool_t generateSignalEvent();
350 
352 
355  Bool_t generateBkgndEvent(UInt_t bgID);
356 
358  void setupGenNtupleBranches();
359 
361  void setDPBranchValues();
362 
364 
368  void generateExtraPdfValues(LauPdfList* extraPdfs, LauEmbeddedData* embeddedData);
369 
371 
374  Bool_t storeSignalMCMatch(LauEmbeddedData* embeddedData);
375 
377 
381  void addSPlotNtupleBranches(const LauPdfList* extraPdfs, const TString& prefix);
382 
384 
389  Double_t setSPlotNtupleBranchValues(LauPdfList* extraPdfs, const TString& prefix, UInt_t iEvt);
390 
392  void updateSigEvents();
393 
395  virtual void setupSPlotNtupleBranches();
396 
398  virtual LauSPlot::NameSet variableNames() const;
399 
401  virtual LauSPlot::NumbMap freeSpeciesNames() const;
402 
404  virtual LauSPlot::NumbMap fixdSpeciesNames() const;
405 
407  virtual LauSPlot::TwoDMap twodimPDFs() const;
408 
410  virtual Bool_t splitSignal() const {return this->useSCF();}
411 
413  virtual Bool_t scfDPSmear() const {return (scfMap_ != 0);}
414 
421 
424  void appendBinCentres( LauFitDataTree* inputData );
425 
426  private:
429 
432 
435 
438 
441 
444 
447 
450 
453 
456 
459 
462 
464  Bool_t usingBkgnd_;
465 
467  UInt_t nSigComp_;
468 
470  UInt_t nSigDPPar_;
471 
474 
476  UInt_t nNormPar_;
477 
479  std::vector<LauAbsCoeffSet*> coeffPars_;
480 
483 
486 
489 
492 
494  std::vector<LauParameter> fitFracAsymm_;
495 
497  std::vector<LauParameter> acp_;
498 
501 
504 
507 
510 
513 
516 
518  Bool_t forceAsym_;
519 
522 
525 
527  const Bool_t tagged_;
528 
530  const TString tagVarName_;
531 
534 
536  std::vector<Int_t> evtCharges_;
537 
539  Bool_t useSCF_;
540 
542  Bool_t useSCFHist_;
543 
546 
549 
552 
554  std::vector<Double_t> recoSCFFracs_;
555 
557  std::vector<Double_t> fakeSCFFracs_;
558 
560  std::vector<Double_t> recoJacobians_;
561 
563  std::vector<Double_t> fakeJacobians_;
564 
567 
569  TString negParent_;
570 
572  TString posParent_;
573 
575  std::vector<LauComplex> negCoeffs_;
576 
578  std::vector<LauComplex> posCoeffs_;
579 
580  // Embedding SP events
583 
586 
589 
592 
594  Bool_t reuseSignal_;
595 
598 
601 
604 
605  // Likelihood values
607  Double_t sigDPLike_;
608 
610  Double_t scfDPLike_;
611 
613  std::vector<Double_t> bkgndDPLike_;
614 
616  Double_t sigExtraLike_;
617 
619  Double_t scfExtraLike_;
620 
622  std::vector<Double_t> bkgndExtraLike_;
623 
625  Double_t sigTotalLike_;
626 
628  Double_t scfTotalLike_;
629 
631  std::vector<Double_t> bkgndTotalLike_;
632 
633  ClassDef(LauCPFitModel,0) // CP fit/ToyMC model
634 
635 };
636 
637 #endif
void generateExtraPdfValues(LauPdfList *extraPdfs, LauEmbeddedData *embeddedData)
Generate from the extra PDFs.
void splitSignalComponent(const TH2 *dpHisto, Bool_t upperHalf=kFALSE, LauScfMap *scfMap=0)
Split the signal component into well-reconstructed and mis-reconstructed parts.
Bool_t generateSignalEvent()
Generate signal event.
Class for defining the abstract interface for signal Dalitz plot dynamics.
The abstract interface for a background Dalitz plot model.
std::vector< LauParameter > acp_
A_CP parameter.
virtual LauSPlot::NameSet variableNames() const
Returns the names of all variables in the fit.
LauKinematics * negKinematics_
The B- Dalitz plot kinematics object.
virtual void printAsymmetries(std::ostream &output)
Print the asymmetries.
LauPdfList negSignalPdfs_
The B- signal PDFs.
Bool_t smearSCFDP() const
Determine if we are smearing the SCF DP PDF.
void addSPlotNtupleBranches(const LauPdfList *extraPdfs, const TString &prefix)
Add sPlot branches for the extra PDFs.
Bool_t forceAsym_
Option to force an asymmetry.
Double_t scfTotalLike_
Total SCF likelihood.
void setExtraPdfParameters()
Set the fit parameters for the extra PDFs.
LauBkgndDPModelList posBkgndDPModels_
The B+ background Dalitz plot models.
UInt_t nNormPar_
Number of parameters.
Bool_t useSCF() const
Determine whether we are splitting the signal into TM and SCF parts.
LauEmbeddedData * posSignalTree_
The B+ signal event tree.
File containing declaration of LauAbsFitModel class.
Int_t curEvtCharge_
Current event charge.
void calcExtraFractions(Bool_t initValues=kFALSE)
Calculate the CP-conserving and CP-violating fit fractions.
LauEmbeddedData * negSignalTree_
The B- signal event tree.
Bool_t useNegReweighting_
Boolean to use reweighting for B-.
std::vector< LauComplex > negCoeffs_
The complex coefficients for B-.
LauBkgndPdfsList posBkgndPdfs_
The B+ background PDFs.
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
Bool_t compareFitData_
Run choice variables.
virtual Bool_t scfDPSmear() const
Check if the mis-reconstructed signal is to be smeared in the DP.
LauParArray negFitFrac_
The B- fit fractions.
virtual void getEvtExtraLikelihoods(UInt_t iEvt)
Determine the signal and background likelihood for the extra variables for a given event...
Double_t sigDPLike_
Signal DP likelihood value.
LauPdfList negScfPdfs_
The B- SCF PDFs.
Bool_t useSCF_
Is the signal split into TM and SCF.
virtual Bool_t genExpt()
Toy MC generation and fitting overloaded functions.
TString negParent_
Name of the parent particle.
TString posParent_
Name of the parent particle.
void embedNegSignal(const TString &fileName, const TString &treeName, Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment=kFALSE, Bool_t useReweighting=kFALSE)
Embed full simulation events for the B- signal, rather than generating toy from the PDFs...
std::vector< Double_t > fakeSCFFracs_
The cached values of the SCF fraction for each bin centre.
std::vector< std::vector< LauParameter > > LauParArray
Type to define an array of parameters.
Bool_t storeSignalMCMatch(LauEmbeddedData *embeddedData)
Store the MC truth info on the TM/SCF nature of the embedded signal event.
Bool_t usingBkgnd_
Background boolean.
LauGenInfo eventsToGenerate()
Determine the number of events to generate for each hypothesis.
std::vector< LauAbsPdf * > LauPdfList
List of Pdfs.
LauBkgndYieldList bkgndAsym_
Background asymmetries(s)
LauParameter negDPRate_
The average DP rate for B-.
std::vector< Double_t > bkgndTotalLike_
Total background likelihood(s)
std::vector< Double_t > recoSCFFracs_
The cached values of the SCF fraction for each event.
LauParameter posDPRate_
The average DP rate for B+.
std::vector< Double_t > bkgndExtraLike_
Background likelihood value(s) from extra PDFs.
void setupGenNtupleBranches()
Setup the required ntuple branches.
LauAbsDPDynamics * posSigModel_
The B+ signal Dalitz plot model.
Double_t scfExtraLike_
SCF likelihood from extra PDFs.
Bool_t reuseSignal_
Boolean to reuse signal events.
LauParArray posFitFrac_
The B+ fit fractions.
virtual void cacheInputFitVars()
Read in the input fit data variables, e.g. m13Sq and m23Sq.
void setSignalDPParameters()
Set the fit parameters for the DP model.
void randomiseInitFitPars()
Randomise the initial fit parameters.
void appendBinCentres(LauFitDataTree *inputData)
virtual void checkInitFitParams()
Check the initial fit parameters.
const Bool_t tagged_
IS the analysis tagged?
UInt_t nExtraPdfPar_
Number of extra PDF parameters.
virtual void finaliseFitResults(const TString &tablePrefixName)
Get the fit results and store them.
virtual void printFitFractions(std::ostream &output)
Print the fit fractions, total DP rate and mean efficiency.
Class for defining a CP fit model.
Abstract interface to the fitting and toy MC model.
const TString tagVarName_
Event charge.
LauParameter * signalEvents_
Signal yield.
std::vector< LauAbsBkgndDPModel * > LauBkgndDPModelList
Typedef for a vector of background DP models.
std::vector< Int_t > evtCharges_
Vector to store event charges.
File containing declaration of LauParameter class.
virtual Bool_t splitSignal() const
Check if the signal is split into well-reconstructed and mis-reconstructed types. ...
std::vector< LauPdfList > LauBkgndPdfsList
Typedef for a vector of background PDFs.
void calcAsymmetries(Bool_t initValues=kFALSE)
Calculate the CP asymmetries.
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
LauScfMap * scfMap_
The smearing matrix for the SCF DP PDF.
Double_t sigExtraLike_
Signal likelihood from extra PDFs.
LauCPFitModel(LauAbsDPDynamics *negModel, LauAbsDPDynamics *posModel, Bool_t tagged=kTRUE, const TString &tagVarName="charge")
Constructor.
virtual void setNBkgndEvents(LauParameter *nBkgndEvents)
Set the background event yield(s)
virtual void initialise()
Initialise the fit.
virtual LauSPlot::NumbMap fixdSpeciesNames() const
Returns the names and yields of species that are fixed in the fit.
Class for defining the abstract interface for complex coefficient classes.
Double_t sigTotalLike_
Total signal likelihood.
void setAmpCoeffSet(LauAbsCoeffSet *coeffSet)
Set the DP amplitude coefficients.
Class for defining the fit parameter objects.
Definition: LauParameter.hh:31
Class to store the data for embedding in toy experiments.
UInt_t nSigComp_
Number of signal components.
virtual void setupSPlotNtupleBranches()
Add branches to store experiment number and the event number within the experiment.
LauParameter * signalAsym_
Signal asymmetry.
std::vector< Double_t > bkgndDPLike_
Background DP likelihood value(s)
void embedNegBkgnd(const TString &bgClass, 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...
LauBkgndEmbDataList negBkgndTree_
The B- background event tree.
LauBkgndReuseEventsList reuseBkgnd_
Vector of booleans to reuse background events.
std::vector< LauAbsCoeffSet * > coeffPars_
Magnitudes and Phases.
LauParameter posMeanEff_
The mean efficiency for B+ model.
LauAbsDPDynamics * negSigModel_
The B- signal Dalitz plot model.
LauParArray CPCFitFrac_
The CP conserving fit fraction.
virtual void setNSigEvents(LauParameter *nSigEvents)
Set the signal event yield.
virtual void weightEvents(const TString &dataFileName, const TString &dataTreeName)
Weight events based on the DP model.
Bool_t usePosReweighting_
Boolean to use reweighting for B+.
Bool_t generateBkgndEvent(UInt_t bgID)
Generate background event.
virtual void writeOutTable(const TString &outputFile)
Write the fit results in latex table format.
std::vector< LauParameter * > LauBkgndYieldList
Typedef for a vector of background yields.
Bool_t useSCFHist() const
Determine whether the SCF fraction is DP-dependent.
Class that implements the efficiency description across the signal Dalitz plot.
Definition: LauEffModel.hh:37
virtual void updateCoeffs()
Update the coefficients.
Double_t setSPlotNtupleBranchValues(LauPdfList *extraPdfs, const TString &prefix, UInt_t iEvt)
Set the branches for the sPlot ntuple with extra PDFs.
virtual ~LauCPFitModel()
Destructor.
std::vector< LauComplex > posCoeffs_
The complex coefficients for B+.
virtual void initialiseDPModels()
Initialise the signal DP models.
void updateSigEvents()
Update the signal events after Minuit sets background parameters.
virtual void setupBkgndVectors()
Define the length of the background vectors.
void setSignalPdfs(LauAbsPdf *negPdf, LauAbsPdf *posPdf)
Set the signal PDFs.
void setFitNEvents()
Set the initial yields.
virtual LauSPlot::TwoDMap twodimPDFs() const
Returns the species and variables for all 2D PDFs in the fit.
virtual LauSPlot::NumbMap freeSpeciesNames() const
Returns the names and yields of species that are free in the fit.
LauEffModel * scfFracHist_
The histogram giving the DP-dependence of the SCF fraction.
UInt_t nSigDPPar_
Number of signal DP parameters.
virtual void propagateParUpdates()
Class for representing the 4D smearing matrix for mis-reconstructed signal (self cross feed) ...
Definition: LauScfMap.hh:29
virtual void storePerEvtLlhds()
Store the per event likelihood values.
Double_t scfDPLike_
SCF DP likelihood value.
std::vector< Double_t > recoJacobians_
The cached values of the sqDP jacobians for each event.
std::vector< Bool_t > LauBkgndReuseEventsList
Typedef for a vector of booleans to flag if events are reused.
virtual Double_t getEventSum() const
Get the total number of events.
Class for defining the abstract interface for PDF classes.
Definition: LauAbsPdf.hh:40
LauPdfList posScfPdfs_
The B+ SCF PDFs.
LauBkgndYieldList bkgndEvents_
Background yield(s)
Class for calculating 3-body kinematic quantities.
LauBkgndDPModelList negBkgndDPModels_
The B- background Dalitz plot models.
LauParArray CPVFitFrac_
The CP violating fit fraction.
LauPdfList posSignalPdfs_
The B+ signal PDFs.
std::vector< Double_t > fakeJacobians_
The cached values of the sqDP jacobians for each true bin.
void embedPosBkgnd(const TString &bgClass, 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...
virtual Double_t getEvtSCFDPLikelihood(UInt_t iEvt)
Calculate the SCF likelihood for the DP for a given event.
std::vector< LauEmbeddedData * > LauBkgndEmbDataList
Typedef for a vector of embedded data objects.
void setSCFPdfs(LauAbsPdf *negPdf, LauAbsPdf *posPdf)
Set the SCF PDF for a given variable.
std::map< std::pair< TString, Int_t >, std::pair< Int_t, Double_t > > LauGenInfo
Define a map to be used to store a category name and numbers.
Bool_t useSCFHist_
Is the SCF fraction DP-dependent.
LauParameter negMeanEff_
The mean efficiency for B- model.
void setBkgndPdfs(const TString &bkgndClass, LauAbsPdf *negPdf, LauAbsPdf *posPdf)
Set the background PDFs.
virtual Double_t getTotEvtLikelihood(UInt_t iEvt)
Get the total likelihood for each event.
virtual void getEvtDPLikelihood(UInt_t iEvt)
Calculate the signal and background likelihoods for the DP for a given event.
LauBkgndEmbDataList posBkgndTree_
The B+ background event tree.
void setBkgndDPModels(const TString &bkgndClass, LauAbsBkgndDPModel *negModel, LauAbsBkgndDPModel *posModel)
Set the background DP models.
LauBkgndPdfsList negBkgndPdfs_
The B- background PDFs.
Class to store the input fit variables.
LauParameter scfFrac_
The (global) SCF fraction parameter.
std::set< TString > NameSet
Type to store names, e.g. of the discriminating/control variables.
Definition: LauSPlot.hh:59
void setDPBranchValues()
Store all of the DP information.
LauKinematics * posKinematics_
The B+ Dalitz plot kinematics object.
void embedPosSignal(const TString &fileName, const TString &treeName, Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment=kFALSE, Bool_t useReweighting=kFALSE)
Embed full simulation events for the B+ signal, rather than generating toy from the PDFs...
std::vector< LauParameter > fitFracAsymm_
The fit fraction asymmetries.
void setExtraNtupleVars()
Set-up other parameters that are derived from the fit results, e.g. fit fractions.