Update 'Utils.hpp'

Utils.hpp.md

@@ -1,3 +1,4 @@
+In this file, various helper functions are defined. Unfortunately, as we are trying to compile and run things within ROOT, it is orders of magnitute easier to have the funcitons defined fully in the header. Including cross-refrences with [[Paths.hpp|Paths.hpp]]. 
 
 
 ## Global variables:
@@ -33,75 +34,13 @@
 
 
 # Functions
-### string GetInputFile()
-
-* **Parameters**
-    * string year
-    * string magnet
-    * bool preSelected
-    * bool MC
-    * bool ReferenceChannel
-    * bool PHSP
-    * bool B0
-    * bool K1
-    * bool Inc
-    * bool smallSample);
-* **Return**
-
-### string GetBDTinputFile()
-
-* **Parameters**
-    * string year
-    * bool MC
-    * bool ReferenceChannel
-    * bool PHSP
-    * bool KshortDecayInVelo);
-* **Return**
-
-### string GetBDToutputFile()
-
-* **Parameters**
-    * string year
-    * int Run
-    * bool MC
-    * bool ReferenceChannel
-    * bool PHSP
-    * bool KshortDecayInVelo
-    * bool UseLowQ2Range
-    * bool reweighted);
-* **Return**
-
-### string GetBDToutputFile()
-
-* **Parameters**
-    * int Run
-    * bool MC
-    * bool ReferenceChannel
-    * bool PHSP
-    * bool KshortDecayInVelo
-    * bool UseLowQ2Range
-    * bool reweighted);
-* **Return**
-
-### string returnFileAddress()
-
-* **Parameters**
-    * string year
-    * int Run
-    * string magnet
-    * bool Preselected
-    * bool BDTed
-    * bool MC
-    * bool ReferenceChannel
-    * bool PHSP
-    * bool KshortDecayInVelo);
-* **Return**
+## Basic names and trees
 
 ### string correct_magnet_string()
-
 * **Parameters**
     * string magnet
 * **Return**
+    * Parsed magnet string name 
 
 ### string treeName()
 
@@ -109,12 +48,14 @@
     * bool MC
     * bool Preselected
 * **Return**
+    * Correct tree name for given sample
 
 ### vector \<string> get_magnet_vector()
 
 * **Parameters**
-    * string magnet
+    * string magnet (up, down or both)
 * **Return**
+    * vector of given polarity(ies), either "up", "down" or both
 
 ### TChain \*get_basic_TChain()
 
@@ -129,6 +70,7 @@
     * bool K1
     * bool Inc
 * **Return**
+    * TChain of all stripped or preselected events
 
 ### TChain \*get_weighted_TChain()
 
@@ -139,6 +81,7 @@
     * bool PHSP
     * bool KshortDecayInVelo
 * **Return**
+    * TChain of all weighted events
 
 ### TChain \*get_BDT_TChain()
 
@@ -150,6 +93,7 @@
     * bool KshortDecayInVelo
     * bool reweighted
 * **Return**
+    * TChain of all events with their MVA response
 
 ### TChain \*get_BDT_TChain()
 
@@ -162,6 +106,7 @@
     * bool KshortDecayInVelo
     * bool reweighted
 * **Return**
+    * TChain of all events with their MVA response
 
 ### TChain \*get_FinalOutput_TChain()
 
@@ -172,6 +117,7 @@
     * bool PHSP
     * bool KshortDecayInVelo //TODO fix Run vs year
 * **Return**
+    * TChain of all events passing the MVA response cut
 
 ### string getTMcut()
 
@@ -181,20 +127,16 @@
     * string customTMbranch
     * bool gammaTM
 * **Return**
+    * String with a ROOT-readable cut on the truth matching variables depending on the input parameters
 
 ### string getJpsicut()
-
-* **Parameters**
-    * 
 * **Return**
-
+    * Cut to keep only the Jpsi Q2 region 
 
 
 ### string getMuMucut()
-
-* **Parameters**
-    * 
 * **Return**
+    * Cut to remove the resonant (phi, Jpsi and Psi2s) Q2 regions
 
 
 
@@ -210,6 +152,7 @@
     * int nExtraBin
     * double TMVAcut
 * **Return**
+    * String with a ROOT-readable cut on Q2, MVA resonse and extra variable in the given bin
 
 ### string getAloneBranch()
 
@@ -219,6 +162,7 @@
     * string customTMbranch
     * bool gammaTM
 * **Return**
+    * Returns the branch with the MVA response at which there are no multiple candidates depending on the TM options
 
 ### string getMultipleCut()
 
@@ -229,6 +173,7 @@
     * bool gammaTM
     * double TMVAcut
 * **Return**
+    * Reutrns a string with the cut on the corresponding [getAloneBranch()](#string-getalonebranch) depending on the TMVA cut
 
 ### string getFinalCut()
 
@@ -248,6 +193,7 @@
     * double TMVAcut
     * bool removeMultiple
 * **Return**
+    * A string combining [getFullCut()](#string-getfullcut), [getTMcut()](#string-gettmcut) and [getMultipleCut()](#string-getmultiplecut)
 
 ### string checkIf2015MC()