diff --git a/BackgroundType-Class.md b/BackgroundType-Class.md index 3c7924c..722900b 100644 --- a/BackgroundType-Class.md +++ b/BackgroundType-Class.md @@ -1,40 +1,42 @@ -## Global variables: -*class BackgroundType{ -*protected: -*public: +## Table of Contents +* [Classes](#classes) + * [BackgroundType](#backgroundtype) +* [Functions and their parameters:](#functions-and-their-parameters) + * [void BackgroundType::setBackgroundType()](#void-backgroundtype-setbackgroundtype) + * [vector<string> BackgroundType::getBkgListOfParams()](#vectorstring-backgroundtype-getbkglistofparams) # Classes ### BackgroundType -* **Private members:** +The protected members are booleans deciding what RooFit function should be used. Public memebrs are a boolean deciding whether to use crystal-ball as background or no backgorund at all, list of constrained parameters and their pdfs and the vector of the background fit variables. +* **Protected members:** + * bool SingleExponential + * bool DoubleExponential + * bool ExpGaus + * bool FixBkgParameters + * bool ConstrBkgParameters * **Public members:** * bool bkgOneCB - * //Constrain PDFs + * RooArgSet \* BkgConsParameter = new RooArgSet() + * RooArgList \* BkgConsPDF = new RooArgList() + * bool BkgAtLeastOneConstrainFound = false + * vectorBkgRooVars = {} + * bool NoBackground * **Functions:** - * **RooArgSet \* BkgConsParameter = new RooArgSet()** - * **Parameters** - * ); - * **Return** - * **RooArgList \* BkgConsPDF = new RooArgList()** - * **Parameters** - * ); - * **Return** - + * [void setBackgroundType(string bkgType, bool TM, bool FixParams, bool ConstrParams)](#void-backgroundtype-setbackgroundtype) + * [vector\ getBkgListOfParams()](#vectorstring-backgroundtype-getbkglistofparams) # Functions and their parameters: ### void BackgroundType::setBackgroundType() - +Parses the string bkgType and sets the Protected members of the class. * **Parameters** * string bkgType * bool TM * bool FixParams - * bool ConstrParams//construct from a string -* **Return** + * bool ConstrParams -### vector BackgroundType::getBkgListOfParams() - -* **Parameters** - * +### vector\ BackgroundType::getBkgListOfParams() * **Return** + * A vector of all variable names from BkgRooVars