From 236659e76aa9ecde1e5a45989de3db556c1dd98c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Renata=20Kopecn=C3=A1?= <kopecna@physi.uni-heidelberg.de>
Date: Mon, 31 Jan 2022 13:46:44 +0100
Subject: [PATCH] Update 'MVA Class'

---
 MVA-Class.md | 81 ++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 69 insertions(+), 12 deletions(-)

diff --git a/MVA-Class.md b/MVA-Class.md
index 531af50..674558a 100644
--- a/MVA-Class.md
+++ b/MVA-Class.md
@@ -1,5 +1,74 @@
+The classes are defined in MVAclass.hpp, the functions performing the training are in MVA.cpp. 
 
 
+# Classes
+### struct MVAconfiguration
+Defines basic properties of the used sample
+* **Members:**
+    * bool SplitYears = false         //Train MVA for each year?
+    * Int_t Run = 1
+    * std::vector<Int_t> years = {2011}
+    * Int_t KShortDecaysInVelo = 1    //LL?
+    * bool SplitInQ2Range = SplitInQ2 //Split the training in Q2 below and above Q2?
+    * bool UseLowQ2Range = true       //If split, use Q2<J/psi?
+    * bool gammaTM = false            //True only true gammas, False: include random gamma
+    * string customTMbranch = "TMed"  //Name of the used truth matching branch
+    * Int_t nConfiguration = 0       //Tag for the outputfiles, useful for testing
+
+### struct MVA_def
+Structure with information needed to read and define the variables used in training
+* **Private members:**
+    * string ReaderName  //Name of the MVA reader
+    * string LaTeXName   //Displayed name in the plots
+    * string Unit        //Unit for the branch
+    * int NoBr           //Number of used branches for the reader (eg min(mu+ chi2, mi- chi2)), one needs 2 branches
+    * string Formula     //formula: Reader = f(Branches)
+    * char DataType      //D: Double_t, F: Float_t, I: Int_t,... (needed to load the branch, because ROOT)
+    
+### class MVA_variables
+* **Private members:**
+    int NoVariables //Total number of variables
+    int NoBranches  //Total number of branches
+* **Public  members:**
+    * vector \<MVA_def> AllVariables // Vector of all variables used in the MVA training
+    * vector \<string> AllBranches   // Vector of all branches that needs to be read from the tree
+* **Functions:**
+    * **MVA_variables()**               //default constructor
+    * **MVA_variables(std::string DL)** // constructor
+    * **~MVA_variables()**              //destuctor        
+    * **void print()**                  
+    * **vector \<string> GetAllReaderNames()**
+    * **int NumberOfVariables()**       // Returns `NoVariables` 
+    * **int NumberOfBranches()**        // Returns `NoBranches`
+    * **vector \<string> GetAllBranches()** //Returns `AllBranches`
+
+
+
+# Functions and their parameters:
+### MVA_variables::MVA_variables()
+
+* **Parameters**
+    * std::string DL
+* **Return**
+
+### MVA_variables::~MVA_variables()
+
+* **Parameters**
+    * 
+* **Return**
+
+### void MVA_variables::print()
+
+* **Parameters**
+    * 
+* **Return**
+
+### vector \<string> MVA_variables::GetAllReaderNames()
+
+* **Parameters**
+    * 
+* **Return**
+
 # Functions and their parameters:
 ### Int_t MVA_b2kmm()
 
@@ -33,15 +102,3 @@
 * **Parameters**
     * Int_t Run = 1
 * **Return**
-
-### if()
-
-* **Parameters**
-    * Kst2Kspiplus)return RunDDandLLKshort
-* **Return**
-
-### if()
-
-* **Parameters**
-    * Kst2Kpluspi0Resolved
-* **Return**