Update 'SignalPdf Class'

SignalPdf-Class.md

@@ -1,46 +1,54 @@
-
-## Global variables:
-
-*class SignalPdf: public ParamValues{
-*public:
-
-
+## Table of Contents
+* [Classes](#classes)
+    * [SignalPdf: public ParamValues](#signalpdf-public-paramvalues)
+* [Functions and their parameters:](#functions-and-their-parameters)
+    * [RooGaussian* SignalPdf::GaussBplus1()](#roogaussian-signalpdf-gaussbplus1)
+    * [RooGaussian* SignalPdf::GaussBplus2()](#roogaussian-signalpdf-gaussbplus2)
+    * [RooCBShape* SignalPdf::CBBplus1()](#roocbshape-signalpdf-cbbplus1)
+    * [RooCBShape* SignalPdf::CBBplus2()](#roocbshape-signalpdf-cbbplus2)
+    * [RooDoubleCB* SignalPdf::CBBplus()](#roodoublecb-signalpdf-cbbplus)
+    * [RooAddPdf* SignalPdf::getBplusMassModel()](#rooaddpdf-signalpdf-getbplusmassmodel)
+    * [void SignalPdf::setAllRooVarsConstant()](#void-signalpdfs-etallroovarsconstant)
 # Classes
 ### SignalPdf: public ParamValues
-* **Private members:**
-* **Public  members:**
 * **Functions:**
-    * **alPdf()**
-        * **Parameters**
-            * }; //default constructor
-        * **Return**
-
+  * SignalPdf(){}; //default constructor
+  * [RooGaussian \*GaussBplus1(RooRealVar \*B_plus_M, RooRealVar \*mean, bool fitRef)](#roogaussian-signalpdf-gaussbplus1)
+  * [RooGaussian \*GaussBplus2(RooRealVar \*B_plus_M, RooRealVar \*mean, bool fitRef)](#roogaussian-signalpdf-gaussbplus2)
+  * [RooCBShape \*CBBplus1(RooRealVar \*B_plus_M, RooRealVar \*mean, bool fitRef)](#roocbshape-signalpdf-cbbplus1)
+  * [RooCBShape \*CBBplus2(RooRealVar \*B_plus_M, RooRealVar \*mean, bool fitRef)](#roocbshape-signalpdf-cbbplus2)
+  * [RooDoubleCB \*CBBplus(RooRealVar \*B_plus_M, RooRealVar \*mean, bool fitRef)](#roodoublecb-signalpdf-cbbplus)
+  * [RooAddPdf \*getBplusMassModel(RooRealVar \*B_plus_M, RooRealVar \*mean, bool fitRef)](#rooaddpdf-signalpdf-getbplusmassmodel)
+  * [void setAllRooVarsConstant()](#void-signalpdfs-etallroovarsconstant)
+  * ~SignalPdf(){} //default destructor
 
+**TODO**  check double getParameter(string parName, RooFitResult *result);
 
 # Functions and their parameters:
 ### RooGaussian\* SignalPdf::GaussBplus1()
-
 * **Parameters**
     * RooRealVar \*B_plus_M
     * RooRealVar \*mean
     * bool fitRef
 * **Return**
+    * Returns RooGaussian: the first gaussian
     
 ### RooGaussian\* SignalPdf::GaussBplus2()
-
 * **Parameters**
     * RooRealVar \*B_plus_M
     * RooRealVar \*mean
     * bool fitRef
 * **Return**
+    * Returns RooGaussian: the second gaussian
 
 ### RooCBShape\* SignalPdf::CBBplus1()
-
+Returns the first crystal ball. Whether it is left or right is assigned later by setting the n and alpha to be positive/negative
 * **Parameters**
     * RooRealVar \*B_plus_M
     * RooRealVar \*mean
     * bool fitRef //could be shortened using the vectors
 * **Return**
+    * Returns RooCBShape: the first crystal ball.
 
 ### RooCBShape\* SignalPdf::CBBplus2()
 
@@ -49,6 +57,7 @@
     * RooRealVar \*mean
     * bool fitRef
 * **Return**
+    * Returns RooCBShape: the second crystal ball.
 
 ### RooDoubleCB\* SignalPdf::CBBplus()
 
@@ -56,18 +65,16 @@
     * RooRealVar \*B_plus_M
     * RooRealVar \*mean
     * bool fitRef
-* **Return**
+* **Return
+    * Returns RooDoubleCB: a double-tailed crystal ball 
 
 ### RooAddPdf\* SignalPdf::getBplusMassModel()
-
 * **Parameters**
     * RooRealVar \*B_plus_M
     * RooRealVar \*mean
     * bool fitRef
 * **Return**
+    * Returns the pdf of the signal model.
 
 ### void SignalPdf::setAllRooVarsConstant()
-
-* **Parameters**
-    * 
-* **Return**
+Takes all the avaialbe parameters in the background pdf and sets them to be constant.