From 55f5d327fbb9223afc42e4dbf7226777817f83cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Renata=20Kopecn=C3=A1?= Date: Tue, 1 Feb 2022 10:22:45 +0100 Subject: [PATCH] Add 'Paths.hpp' --- Paths.hpp.md | 661 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 661 insertions(+) create mode 100644 Paths.hpp.md diff --git a/Paths.hpp.md b/Paths.hpp.md new file mode 100644 index 0000000..610e206 --- /dev/null +++ b/Paths.hpp.md @@ -0,0 +1,661 @@ + + + +# Functions and their parameters + +### string getOriginalFiles() + +* **Parameters** + * string year + * string magnet + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool smallSample +* **Return** + * Returns the address of the stripped files (wildcard instead of the file numbers, if smallSample, returns one specific file path). + +### string GetInputFile() + +* **Parameters** + * string year/int year + * string magnet + * bool preSelected + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool smallSample +* **Return** + * Returns file path ot the required sample. + +### string GetInputFileBkg() +Dedicated function needed as the background samples were saved in a different place than the resto of the files. +* **Parameters** + * string year/int year + * string magnet + * bool preSelected + * bool ReferenceChannel + * bool B0 + * bool K1 + * bool Inc +* **Return** + * Returns file path ot the required background sample. + +### string GetInputFile() +* **Parameters** + * string year + * string magnet + * bool preSelected + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool B0 + * bool K1 + * bool Inc + * bool smallSample +* **Return** + * Either [GetInputFile()](string-getinputfile) or [GetInputFileBkg()](string-getinputfilebkg) + +### string GetHistosFile() + +* **Parameters** + * string year/int year + * string magnet + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool smallSample +* **Return** + * The path of the histogram file created by [preSelection()](https://git.physi.uni-heidelberg.de/kopecna/EWP-BplusToKstMuMu-AngAna/wiki/BDTSelection#preselection). + + +### string GetHistosFileBkg() + +* **Parameters** + * string year/int year + * string magnet + * bool ReferenceChannel + * bool B0 + * bool K1 + * bool Inc +* **Return** + * The path of the histogram file created by [preSelection()](https://git.physi.uni-heidelberg.de/kopecna/EWP-BplusToKstMuMu-AngAna/wiki/BDTSelection#preselection) + + +### string GetGenLevelFile() + +* **Parameters** + * bool ReferenceChannel + * bool PHSP //TODO +* **Return** + * Path to the generator-level MC samples + + +### string GetBDTinputFile() + +* **Parameters** + * string year/int year + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool KshortDecayInVelo +* **Return** + * Path to the preselected data/MC files created by [preSelection()](https://git.physi.uni-heidelberg.de/kopecna/EWP-BplusToKstMuMu-AngAna/wiki/BDTSelection#preselection) + + +### string GetBDToutputFile() + +* **Parameters** + * string year/int year + * int Run + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool KshortDecayInVelo + * bool UseLowQ2Range + * bool reweighted +* **Return** + * Path to the files containing the MVA response created by [TMVAClassificationApplication_b2kmm()](https://git.physi.uni-heidelberg.de/kopecna/EWP-BplusToKstMuMu-AngAna/wiki/TMVA-Class-application#int_t-tmvaclassificationapplication_b2kmm). + +### string GetBDToutputFile() + +* **Parameters** + * int Run + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool KshortDecayInVelo + * bool UseLowQ2Range + * bool reweighted +* **Return** + * [string GetBDToutputFile()](#string-getbdtoutputfile) with no year + +### string GetBDTConfigFile() +* **Parameters** + * bool SplitYears + * int year + * int Run + * bool KShortDecaysInVelo + * int nConfiguration + * bool UseLowQ2Range + * string customTMbranch + * bool gammaTM +* **Return** + * Path to the config file created by [MVA_b2kmm()](https://git.physi.uni-heidelberg.de/kopecna/EWP-BplusToKstMuMu-AngAna/wiki/MVA-Class#int_t-mva_b2kmm). + +### string GetFinalOutputFile() + +* **Parameters** + * string year/int year + * int Run + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool KshortDecayInVelo + * bool UseLowQ2Range +* **Return** + * Patht to the tuple files containing the trees after applying the MVA cut. + +### string GetFinalOutputFile() + +* **Parameters** + * int year + * int Run + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool KshortDecayInVelo + * bool UseLowQ2Range +* **Return** + * [string GetFinalOutputFile()](#string-getfinaloutputfile) with no year + + +### string GetControlPlots() + +* **Parameters** + * string year + * bool ReferenceChannel + * bool PHSP + * bool KshortDecayInVelo + * bool sWeightUse + * int canvas +* **Return** + +### string GetMassFitFile() + +* **Parameters** + * std::string year + * string magnet + * int Run + * bool MC + * bool Preselected + * bool TM + * bool PHSP + * //input/output file selectionbool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * //signal/referencebool GetShapeFromMC + * string SignalType + * string BckGndType + * bool ConstrainParameters + * //shape from MC?bool KshortDecaysInVelo + * bool UseLowQ2Range + * //LL/DD? // q2 rangeDouble_t TMVAcut + * int randomSubset + * //TMVA optionsbool fixedMassRegion + * bool yieldOverFullRange + * //fit range optionsstring sExtraVar + * int nExtraBin + * //Efficiency in different variable + * binnedbool removeMultiple + * bool weighted + * bool weightedFromPi0 + * string whichWeight + * bool notTM + * string customTMbranch + * bool gammaTM + * bool InclusiveSample +* **Return** + +### string GetMassFitFile() + +* **Parameters** + * std::string year + * bool MC + * bool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * bool KshortDecaysInVelo + * bool GetShapeFromMC + * string SignalType + * string BckGndType + * bool ConstrainParameters + * //shape from MC?bool fixedMassRegion + * bool weighted //fit range options +* **Return** + +### string GetMassFitFile() + +* **Parameters** + * std::string year + * int Run + * bool MC + * bool PHSP + * //input/output file selectionbool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * //signal/referencebool GetShapeFromMC + * string SignalType + * string BckGndType + * bool ConstrainParameters + * //shape from MC?bool KshortDecaysInVelo + * bool UseLowQ2Range + * //LL/DD? // q2 rangeDouble_t TMVAcut + * //TMVA optionsbool fixedMassRegion + * //fit range optionsbool removeMultiple //fit range options +* **Return** + +### string GetEfficiencyMassFitFile() + +* **Parameters** + * std::string year + * string magnet + * int Run + * bool Preselected + * bool TM + * bool PHSP + * //input/output file selectionbool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * //signal/referencebool GetShapeFromMC + * string SignalType + * string BckGndType + * bool ConstrainParameters + * //shape from MC?bool KshortDecaysInVelo + * bool UseLowQ2Range + * //LL/DD? // q2 rangeDouble_t TMVAcut + * //TMVA optionsbool fixedMassRegion + * //fit range optionsstring sExtraVar + * int nExtraBin + * //Efficiency in different variable + * binnedbool removeMultiple + * bool weighted + * bool weightedFromPi0 + * string whichWeight + * string customTMbranch + * bool gammaTM +* **Return** + +### string GetEfficiencyPi0MassFitFile() + +* **Parameters** + * bool fromPi0 + * string year + * string magnet + * int Run + * string customTMbranch + * bool gammaTM + * int nBins + * bool fixSigma + * bool fixMass + * bool useFancyFit + * bool simFit + * bool binnedFit + * bool UseOnlyMuMuEvents + * bool PHSP + * bool RemoveMultiple + * bool weighted + * bool weightedFromPi0 + * string whichWeight + * string sExtraVar + * int nExtraBin +* **Return** + +### string GetEfficiencyFile() + +* **Parameters** + * string effType + * string year + * string magnet + * int Run + * //input/output file selectionbool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * bool PHSP + * bool KshortDecayInVelo + * bool RemoveMultiple + * bool weighted + * bool weightedFromPi0 + * string whichWeight + * bool UseLowQ2Range + * bool useFancyFit + * string sExtraVar + * string customTMbranch + * bool gammaTM + * int nBins + * bool fixSigma + * bool fixMass + * bool simFit + * bool binnedFit + * bool sigEff +* **Return** + +### string GetEfficiencyFileTM() + +* **Parameters** + * string effType + * string year + * string magnet + * int Run + * //input/output file selectionbool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * bool PHSP + * bool KshortDecayInVelo + * bool RemoveMultiple + * bool weighted + * bool weightedFromPi0 + * string whichWeight + * bool UseLowQ2Range + * bool useFancyFit + * string sExtraVar + * bool sigEff + * string customTMbranch + * bool gammaTM +* **Return** + +### string GetEfficiencyFilePi0TM() + +* **Parameters** + * string year + * int Run + * //input/output file selectionbool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * bool PHSP + * bool weightedFromPi0 + * string whichWeight + * bool useFancyFit + * string sExtraVar + * bool sigEff +* **Return** + +### string GetEfficiencyFile() + +* **Parameters** + * string effType + * string year + * string magnet + * int Run + * //input/output file selectionbool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * bool PHSP + * bool KshortDecayInVelo + * bool RemoveMultiple + * bool weighted + * bool UseLowQ2Range + * bool useFancyFit + * string sExtraVar + * string customTMbranch + * bool gammaTM +* **Return** + +### string GetEfficiencyFile() + +* **Parameters** + * string effType + * string year + * string magnet + * int Run + * bool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * bool PHSP + * bool KshortDecayInVelo + * bool RemoveMultiple + * bool weighted + * bool UseLowQ2Range + * bool useFancyFit + * string sExtraVar +* **Return** + +### string GetEfficiencyFile() + +* **Parameters** + * string effType + * string year + * string magnet + * bool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * bool PHSP + * bool KshortDecayInVelo + * bool RemoveMultiple + * bool weighted + * bool UseLowQ2Range + * bool useFancyFit + * string sExtraVar +* **Return** + +### string GetEfficiencyFile() + +* **Parameters** + * string effType + * string magnet + * int Run + * bool UseOnlyJpsiEvents + * bool UseOnlyMuMuEvents + * bool PHSP + * bool KshortDecayInVelo + * bool RemoveMultiple + * bool weighted + * bool UseLowQ2Range + * bool useFancyFit + * string sExtraVar +* **Return** + +### string GetBDTScanFile() + +* **Parameters** + * string year + * string magnet + * int Run + * //input/output file selectionbool KshortDecayInVelo + * bool UseLowQ2Range + * bool fineScan +* **Return** + +### string GetBDTScanBackgroundFitFile() + +* **Parameters** + * string year + * int Run + * //input/output file selectionbool KshortDecayInVelo + * bool UseLowQ2Range + * double TMVAcut +* **Return** + +### string GetTMVAplotsFolder() + +* **Parameters** + * int year + * int Run + * bool SplitYears + * bool KshortDecaysInVelo + * int nConfiguration + * bool UseLowQ2Range + * string customTMbranch + * bool gammaTM +* **Return** + +### string GetTMVAplotsFolder() + +* **Parameters** + * int year + * int Run + * bool SplitYears + * bool KshortDecaysInVelo + * int nConfiguration + * bool UseLowQ2Range +* **Return** + +### string getResolutionFile() + +* **Parameters** + * string year + * int Run + * bool TM + * bool RemoveMultiple + * double TMVAcut + * bool ReferenceChannel + * bool PHSP + * bool KshortDecayInVelo +* **Return** + +### string returnFileAddress() + +* **Parameters** + * string year + * int Run + * string magnet + * bool Preselected + * bool BDTed + * bool MC + * bool ReferenceChannel + * bool PHSP + * bool KshortDecayInVelo +* **Return** + +### std::string dataTypeString() + +* **Parameters** + * bool MC + * bool Reference + * bool PHSP + * bool B0 + * bool K1 + * bool Inc +* **Return** + +### string getTMplotsFolder() + +* **Parameters** + * string year + * bool Reference + * bool PHSP + * bool B0 + * bool K1 + * bool Inc +* **Return** + +### string getTMplotsPath() + +* **Parameters** + * string name + * string year + * bool Reference + * bool PHSP + * bool B0 + * bool K1 + * bool Inc +* **Return** + +### bool restore_from_backup() + +* **Parameters** + * string year + * string magnet + * bool MC + * bool ReferenceChannel + * bool PHSP +* **Return** + +### bool restore_allYears_from_backup() + +* **Parameters** + * bool MC + * bool ReferenceChannel + * bool PHSP +* **Return** + +### bool restore_allData_from_backup() + +* **Parameters** + * +* **Return** + +### int restore_allMCsig_from_backup() + +* **Parameters** + * +* **Return** + +### int restore_allMCref_from_backup() + +* **Parameters** + * +* **Return** + +### int restore_allPHSP_from_backup() + +* **Parameters** + * +* **Return** + +### int restore_allMC_from_backup() + +* **Parameters** + * +* **Return** + +### bool create_backup() + +* **Parameters** + * string year + * string magnet + * bool MC + * bool ReferenceChannel + * bool PHSP +* **Return** + +### bool create_allYears_backup() + +* **Parameters** + * bool MC + * bool ReferenceChannel + * bool PHSP +* **Return** + +### bool create_allData_backup() + +* **Parameters** + * +* **Return** + +### int create_allMCsig_backup() + +* **Parameters** + * +* **Return** + +### int create_allMCref_backup() + +* **Parameters** + * +* **Return** + +### int create_allPHSP_backup() + +* **Parameters** + * +* **Return** + +### int create_allMC_backup() + +* **Parameters** + * +* **Return** + +### bool create_backup_MCsig() + +* **Parameters** + * string year + * string magnet +* **Return** + +### int create_backup_All_MCsig() + +* **Parameters** + * +* **Return**