Update 'Efficiency Class'

Efficiency-Class.md

@@ -1,42 +1,46 @@
-Welcome to the Wiki.
+File defining the `EffAndError` class. The class contains of three memebers; value, upper error and lower error. It is used to save efficiencies in [[Efficiency.cpp|Efficiency.cpp]]. It was originially thought we will have to calculate the efficiency errors properly, however, turns out we don't. But if someone wants to, they hapilly can my simply modifying the functions in this file.
+# Global variables:
 
-## Global variables:
+string mainSignalShape = "OneCB" (Defines the shape used in the B+ mass fit, possibly obsolete)
 
 # Classes
 ### EffAndError
-* **Private members:**
+
 * **Public  members:**
+    * double value
+    * double highError
+    * double lowError
 * **Functions:**
-    * **EffAndError()**
-        * **Parameters**
-            * //default constructor
-        * **Return**
-    * **EffAndError()**
-        * **Parameters**
-            * double val //default constructor
-        * **Return**
-    * **EffAndError()**
-        * **Parameters**
-            * double val
-            * double highErr
-            * double lowErr //default constructor
-        * **Return**
-    * **~EffAndError()**
-        * **Parameters**
-            * );   //destuctor
-        * **Return**
+    * EffAndError() //default constructor        
+    * EffAndError(double val) // constructor
+    * EffAndError(double val,double highErr, double lowErr) //constructor
+    * **~EffAndError()** //default destructor
 
 
-
-# Functions and their parameters:
-### EffAndError::~EffAndError()
+# Functions
+### EffAndError::EffAndError()
 
 * **Parameters**
-    * //destuctor
 * **Return**
+    * Inititalized EffAndError class with all members set to zero.
+    * 
+### EffAndError::EffAndError()
+
+* **Parameters**
+    * double val
+* **Return**
+    * Inititalized EffAndError class with set value and zero errors.
+
+### EffAndError::EffAndError()
+* **Parameters**
+    * double val
+    * double highErr
+    * double lowErr
+* **Return**
+    * Inititalized EffAndError class with given values
 
 ### EffAndError GetEfficiency()
-
+Takes two files as input, from them reads the TVectorD with given name, can be different for Denominator and numerator. The division of the two numbers is saved as EffAndError without errors.
 * **Parameters**
     * TFile \*fitFileNumerator
     * string nameNumerator
@@ -57,8 +61,9 @@ Welcome to the Wiki.
     * string sExtraVar
     * int nExtraBin
     * string customTMbranch
-    * bool gammaTM  //TODO: add customTMbranch and gammaTM
+    * bool gammaTM 
 * **Return**
+    * Truth-matching efficiency without errors calculated by counting the events in the truth matched tuples.
 
 ### EffAndError getBDTEfficiencySimple()
 
@@ -74,6 +79,7 @@ Welcome to the Wiki.
     * string sExtraVar
     * int nExtraBin //TODO: check weight
 * **Return**
+    * Truth-matching efficiency without errors calculated by counting the events in the truth matched tuples with given MVA cut.
 
 ### EffAndError getSelectionEfficiencySimple()
 
@@ -90,5 +96,6 @@ Welcome to the Wiki.
     * string sExtraVar
     * int nExtraBin
     * string customTMbranch
-    * bool gammaTM  //For studies on variables
+    * bool gammaTM  
 * **Return**
+    * Selection efficiency without errors calculated by counting the events in the truth matched tuples.