From 5dc0abae03df41c6b031847f7e312d2b66c504a8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Renata=20Kopecn=C3=A1?= <kopecna@physi.uni-heidelberg.de>
Date: Thu, 3 Feb 2022 13:59:22 +0100
Subject: [PATCH] Update 'Signal Study'

---
 Signal-Study.md | 104 ++++++++++++++++++++++++++++--------------------
 1 file changed, 61 insertions(+), 43 deletions(-)

diff --git a/Signal-Study.md b/Signal-Study.md
index 4ccb50a..d48e6a1 100644
--- a/Signal-Study.md
+++ b/Signal-Study.md
@@ -1,79 +1,91 @@
 
+## Table of Contents
 
-## Global variables:
-
-* class YieldInfo{
-* public:
+* [Classes](#classes)
+    * [YieldInfo](#yieldinfo)
+* [Functions](#functions)
+   * [Plotting](#plotting)
+      * [void YieldInfo::addYield()](#void-yieldinfoaddyield)
+      * [double getValueFromTGraph()](#double-getvaluefromtgraph)
+      * [bool yieldComparison()](#bool-yieldcomparison)
+      * [YieldInfo yieldInQ2()](#yieldinfo-yieldinq2)
+      * [bool plotYieldInQ2()](#bool-plotyieldinq2)
+   * [MVA cut](#mva-cut)
+      * [bool ApplyCut()](#bool-applycut)
+      * [bool ApplyCutPerYear()](#bool-applycutperyear)
+      * [bool ApplyCutToAll()](#bool-applycuttoall)
+      * [bool ApplyCutPerYearAll()](#bool-applycutperyearall)
+      * [bool ApplyCutPerYearAll()](#bool-applycutperyearall-1)
+      * [bool printYileds()](#bool-printyileds)
 
 
 # Classes
 ### YieldInfo
-* **Private members:**
-* **Public  members:**
-* **Functions:**
-    * **YieldInfo()**
-[comment]: # ([o()](#yieldinfo))
-        * **Parameters**
-            * //default constructor
-        * **Return**
-    * **void addYield()**
-[comment]: # ([addYield()](#void-addyield))
-        * **Parameters**
-            * YieldInfo addInfo
-        * **Return**
-    * **~YieldInfo()**
-[comment]: # ([o()](#~yieldinfo))
-        * **Parameters**
-            * );   //destuctor
-        * **Return**
 
+* **Public  members:**
+    * double sigYield
+    * double sigYieldErr
+    * double bkgYield
+    * double bkgYieldErr
+    * double significance
+* **Functions:**
+    * **YieldInfo()** //default constructor
+    * **void [addYield()](#void-addyield)**
+    * **~YieldInfo()**  //destuctor
 
 
 # Functions
-### YieldInfo::~YieldInfo()
-[comment]: # ([o()](#yieldinfo-~yieldinfo))
+## Plotting
 
+### void YieldInfo::addYield()
+[comment]: # ([o()](#yieldinfo-addYield))
+Adds together two YieldInfo classes: makes a sum of the current YiledInfo and `addInfo`. Recalculates the significance accordingly.
 * **Parameters**
-    * //destuctor
-* **Return**
+    * YieldInfo addInfo
+    
 
 ### double getValueFromTGraph()
 [comment]: # ([getValueFromTGraph()](#double-getvaluefromtgraph))
-
+Reads the expected yields and significances from the TGraph with `name` saved in the `fitFile`.
 * **Parameters**
     * string name
     * TFile \*fitFile
     * double TMVAcut
 * **Return**
+    * Values of TGraphs for given MVA cut
 
 ### bool yieldComparison()
 [comment]: # ([yieldComparison()](#bool-yieldcomparison))
-
+Reads the expected signal+background yield and significance as well as the actuall yield and significance and prints the values in a form of LaTeX table er Run
 * **Parameters**
     * int Run
     * double TMVAcut
 * **Return**
+    * Always 1
 
 ### YieldInfo yieldInQ2()
+Performs the B plus mass fit in all the Q2 bins to rare data. Loads the results into the YieldInfo.
 [comment]: # ([yieldInQ2()](#yieldinfo-yieldinq2))
-
 * **Parameters**
     * int Run
     * double TMVAcut
     * int nBin
-    * bool doFit
+    * bool doFit (if false, don't fit, just read)
 * **Return**
+    * YieldInfo filled from B plus mass fit to rare data
 
 ### bool plotYieldInQ2()
 [comment]: # ([plotYieldInQ2()](#bool-plotyieldinq2))
-
+Reads the TGraphs with signal and background yields as well as the actual significance. Also reads the CMS's significance (numbers are saved in the function) and plots it all in one nice even though complicated plot, one per Run and one for both runs.
 * **Parameters**
     * bool fixRange
 * **Return**
+    * Always True
 
+## MVA cut
 ### bool ApplyCut()
 [comment]: # ([ApplyCut()](#bool-applycut))
-
+Reads the BDT output tree and creates a new reduced tree by applying a cut on the MVA response defined in [[GlobalFunctions.hh|GlobalFunctions.hh]] for given Run. 
 * **Parameters**
     * int Run
     * bool MC
@@ -81,10 +93,11 @@
     * bool PHSP
     * double TMVAcut
 * **Return**
+    * Always True
 
 ### bool ApplyCutPerYear()
 [comment]: # ([ApplyCutPerYear()](#bool-applycutperyear))
-
+Reads the BDT output tree and creates a new reduced tree by applying a cut on the given MVA response. 
 * **Parameters**
     * int Run
     * bool MC
@@ -92,33 +105,38 @@
     * bool PHSP
     * double TMVAcut
 * **Return**
+    * Always True
 
 ### bool ApplyCutToAll()
 [comment]: # ([ApplyCutToAll()](#bool-applycuttoall))
+Calls [ApplyCut()](#bool-applycut) for data, signal MC, reference MC and PHSP MC samples.
+* **Parameters**
+    * int Run
+    * double TMVAcut
+* **Return**
+    * Always True
+
+### bool ApplyCutPerYearAll()
+[comment]: # ([ApplyCutPerYearAll()](#bool-applycutperyearall))
+Calls [ApplyCutPerYear()](#bool-applycutperyear) for data, signal MC, reference MC and PHSP MC samples.
 
 * **Parameters**
     * int Run
     * double TMVAcut
 * **Return**
+    * Always True
 
 ### bool ApplyCutPerYearAll()
 [comment]: # ([ApplyCutPerYearAll()](#bool-applycutperyearall))
-
-* **Parameters**
-    * int Run
-    * double TMVAcut
-* **Return**
-
-### bool ApplyCutPerYearAll()
-[comment]: # ([ApplyCutPerYearAll()](#bool-applycutperyearall))
-
+Calls [ApplyCutPerYearAll()](#bool-applycutperyearall) for given run, applying a cut on the MVA response defined in [[GlobalFunctions.hh|GlobalFunctions.hh]] . 
 * **Parameters**
     * int Run
 * **Return**
 
 ### bool printYileds()
 [comment]: # ([printYileds()](#bool-printyileds))
-
+Prints a LaTeX table with the number of candidates fro each selection step: triger and stripping, preselection and MVA selection.
 * **Parameters**
     * bool Rare
 * **Return**
+    * Always True
\ No newline at end of file