laura is hosted by Hepforge, IPPP Durham
Laura++  v3r2
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 - 2014.
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 "LauComplex.hh"
32 #include "LauParameter.hh"
33 
34 class TH2;
35 class LauAbsBkgndDPModel;
36 class LauAbsCoeffSet;
37 class LauIsobarDynamics;
38 class LauAbsPdf;
39 class LauEffModel;
40 class LauEmbeddedData;
41 class LauKinematics;
42 class LauScfMap;
43 
44 
46 
47  public:
49 
52  explicit LauSimpleFitModel(LauIsobarDynamics* sigDPModel);
53 
55  virtual ~LauSimpleFitModel();
56 
58 
61  virtual void setNSigEvents(LauParameter* nSigEvents);
62 
64 
69  virtual void setNBkgndEvents(LauParameter* nBkgndEvents);
70 
72 
76  void setBkgndDPModel(const TString& bkgndClass, LauAbsBkgndDPModel* bkgndModel);
77 
79 
89  void splitSignalComponent( const TH2* dpHisto, const Bool_t upperHalf = kFALSE, const Bool_t fluctuateBins = kFALSE, LauScfMap* scfMap = 0 );
90 
92 
99  void splitSignalComponent( const Double_t scfFrac, const Bool_t fixed );
100 
102  Bool_t useSCF() const { return useSCF_; }
103 
105  Bool_t useSCFHist() const { return useSCFHist_; }
106 
108  Bool_t smearSCFDP() const { return (scfMap_ != 0); }
109 
111 
114  void setSignalPdf(LauAbsPdf* pdf);
115 
117 
120  void setSCFPdf(LauAbsPdf* pdf);
121 
123 
127  void setBkgndPdf(const TString& bkgndClass, LauAbsPdf* pdf);
128 
130 
137  void embedSignal(const TString& fileName, const TString& treeName,
138  Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment = kFALSE,
139  Bool_t useReweighting = kFALSE);
140 
142 
149  void embedBkgnd(const TString& bkgndClass, const TString& fileName, const TString& treeName,
150  Bool_t reuseEventsWithinEnsemble, Bool_t reuseEventsWithinExperiment = kFALSE);
151 
153 
160  virtual void setAmpCoeffSet(LauAbsCoeffSet* coeffSet);
161 
162  protected:
164  typedef std::map< TString, std::pair<Int_t,Double_t> > LauGenInfo;
165 
167  typedef std::vector<LauAbsBkgndDPModel*> LauBkgndDPModelList;
168 
170  typedef std::vector<LauPdfList> LauBkgndPdfsList;
171 
173  typedef std::vector<LauParameter*> LauBkgndYieldList;
174 
176  typedef std::vector<LauEmbeddedData*> LauBkgndEmbDataList;
177 
179  typedef std::vector<Bool_t> LauBkgndReuseEventsList;
180 
182 
186  virtual void weightEvents( const TString& dataFileName, const TString& dataTreeName );
187 
189  virtual void initialise();
190 
192  virtual void initialiseDPModels();
193 
195  virtual void recalculateNormalisation();
196 
198  virtual void updateCoeffs();
199 
201  virtual Bool_t genExpt();
202 
204  virtual void propagateParUpdates();
205 
207  virtual void cacheInputFitVars();
208 
210  virtual void checkInitFitParams();
211 
213 
216  virtual void finaliseFitResults(const TString& tablePrefixName);
217 
219 
222  virtual void printFitFractions(std::ostream& output);
223 
225 
228  virtual void writeOutTable(const TString& outputFile);
229 
231 
234  virtual void savePDFPlots(const TString& label);
235 
237 
241  virtual void savePDFPlotsWave(const TString& label, const Int_t& spin);
242 
244  virtual void storePerEvtLlhds();
245 
246  // Methods to do with calculating the likelihood functions
247  // and manipulating the fitting parameters.
248 
250 
253  virtual Double_t getTotEvtLikelihood(UInt_t iEvt);
254 
256 
259  virtual void getEvtDPLikelihood(UInt_t iEvt);
260 
262 
265  virtual Double_t getEvtSCFDPLikelihood(UInt_t iEvt);
266 
268 
271  virtual void getEvtExtraLikelihoods(UInt_t iEvt);
272 
274 
277  virtual Double_t getEventSum() const;
278 
280  void setSignalDPParameters();
281 
283  void setExtraPdfParameters();
284 
286  void setFitNEvents();
287 
289  void setExtraNtupleVars();
290 
292  void randomiseInitFitPars();
293 
295  virtual void setupBkgndVectors();
296 
298  std::pair<LauGenInfo,Bool_t> eventsToGenerate();
299 
301  Bool_t generateSignalEvent();
302 
304 
307  Bool_t generateBkgndEvent(UInt_t bkgndID);
308 
310  void setupGenNtupleBranches();
311 
313  void setDPBranchValues();
314 
316 
320  void generateExtraPdfValues(LauPdfList* extraPdfs, LauEmbeddedData* embeddedData);
321 
323 
327  void addSPlotNtupleBranches(const LauPdfList* extraPdfs, const TString& prefix);
328 
330 
335  Double_t setSPlotNtupleBranchValues(LauPdfList* extraPdfs, const TString& prefix, UInt_t iEvt);
336 
338  void updateSigEvents();
339 
341  virtual void setupSPlotNtupleBranches();
342 
344  virtual LauSPlot::NameSet variableNames() const;
345 
347  virtual LauSPlot::NumbMap freeSpeciesNames() const;
348 
350  virtual LauSPlot::NumbMap fixdSpeciesNames() const;
351 
353  virtual LauSPlot::TwoDMap twodimPDFs() const;
354 
356  virtual Bool_t splitSignal() const {return this->useSCF();}
357 
359  virtual Bool_t scfDPSmear() const {return (scfMap_ != 0);}
360 
362 
372  void appendBinCentres( LauFitDataTree* inputData );
373 
374  private:
377 
380 
383 
386 
389 
392 
395 
398 
400  Bool_t usingBkgnd_;
401 
403  UInt_t nSigComp_;
404 
406  UInt_t nSigDPPar_;
407 
409  UInt_t nExtraPdfPar_;
410 
412  UInt_t nNormPar_;
413 
415  std::vector<LauAbsCoeffSet*> coeffPars_;
416 
419 
422 
425 
428 
431 
434 
436  Bool_t useSCF_;
437 
439  Bool_t useSCFHist_;
440 
443 
446 
449 
451  std::vector<Double_t> recoSCFFracs_;
452 
454  std::vector<Double_t> fakeSCFFracs_;
455 
457  std::vector<Double_t> recoJacobians_;
458 
460  std::vector<Double_t> fakeJacobians_;
461 
464 
466  std::vector<LauComplex> coeffs_;
467 
468  // Embedding full simulation events
469 
472 
475 
477  Bool_t reuseSignal_;
478 
481 
484 
486  Double_t sigDPLike_;
487 
489  Double_t scfDPLike_;
490 
492  std::vector<Double_t> bkgndDPLike_;
493 
495  Double_t sigExtraLike_;
496 
498  Double_t scfExtraLike_;
499 
501  std::vector<Double_t> bkgndExtraLike_;
502 
504  Double_t sigTotalLike_;
505 
507  Double_t scfTotalLike_;
508 
510  std::vector<Double_t> bkgndTotalLike_;
511 
512  ClassDef(LauSimpleFitModel,0) // Total fit/ToyMC model
513 
514 };
515 
516 #endif
void setSignalPdf(LauAbsPdf *pdf)
Set the signal PDF for a given variable.
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.
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.
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.
void splitSignalComponent(const TH2 *dpHisto, const Bool_t upperHalf=kFALSE, const Bool_t fluctuateBins=kFALSE, LauScfMap *scfMap=0)
Split the signal component into well-reconstructed and mis-reconstructed parts.
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 savePDFPlots(const TString &label)
Save the pdf Plots for all the resonances of experiment number fitExp.
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()
Calculate things that depend on the fit parameters after they have been updated by Minuit...
Bool_t useSCFHist_
Is the SCF fraction DP-dependent.
virtual void savePDFPlotsWave(const TString &label, const Int_t &spin)
Save the pdf Plots for the sum of ressonances correspondint to &quot;sin&quot; of experiment number fitExp...
LauBkgndReuseEventsList reuseBkgnd_
Vector of booleans to reuse background events.
ClassDef(LauSimFitSlave, 0)
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.
LauIsobarDynamics * sigDPModel_
The signal Dalitz plot model.
LauSimpleFitModel(LauIsobarDynamics *sigDPModel)
Constructor.
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 normalisation parameters (i.e. yields)
void setupGenNtupleBranches()
Setup the required ntuple branches.
void appendBinCentres(LauFitDataTree *inputData)
Append fake data points to the inputData for each bin in the SCF smearing matrix. ...
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.
File containing declaration of LauComplex class.
virtual void setupBkgndVectors()
Define the length of the background vectors.
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:35
LauBkgndDPModelList bkgndDPModels_
The background Dalitz Plot model.
Class to store the data for embedding in toy experiments.
LauParArray fitFracEffUnCorr_
Fit fractions (uncorrected for the efficiency)
virtual void recalculateNormalisation()
Recalculate Normalization the signal DP models.
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.
LauSimpleFitModel & operator=(const LauSimpleFitModel &rhs)
Copy assignment operator (not implemented)
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.
Class for defining signal dynamics using the isobar model.
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:41
Class for calculating 3-body kinematic quantities.
std::pair< LauGenInfo, Bool_t > eventsToGenerate()
Determine the number of events to generate for each hypothesis.
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.