diff --git a/SignalType-Class.md b/SignalType-Class.md index d1f14b4..ec5d78d 100644 --- a/SignalType-Class.md +++ b/SignalType-Class.md @@ -1,54 +1,61 @@ -## Global variables: -*class SignalType{ -*protected: -*public: +## Table of Contents + +* [Classes](#classes) + * [SignalType](#signaltype) +* [Functions and their parameters:](#functions-and-their-parameters) + * [void SignalType::setSignalType()](#void-signaltype-setsignaltype) + * [vector SignalType::getSigListOfParams()](#vector-signaltype-getsiglistofparams) + * [double SignalType::getEffSigmaFromResult()](#double-signaltype-geteffsigmafromresult) + # Classes ### SignalType -* **Private members:** +The protected members are booleans deciding what RooFit function should be used. Public memebrs are a boolean deciding what signal part is used, whether there is any gaussian involved, whether there are any fixed or contrained paramatrs. +The public members are the list of constrained parameters and their pdfs, boolean checking whether there is any contrain, and the vector of the signal fit variables. +* **Protected members:** + * bool SingleGaussian; + * bool DoubleGaussian; + * bool DoubleCB; + * bool LeftCB; + * bool RightCB; + * bool OneCB; + * bool anyGaussain; //false => it's a CB + * bool FixParameters; + * bool ConstrParameters; * **Public members:** * bool NoSig - * //Constrain PDFs -* **Functions:** * **RooArgSet \* ConsParameter = new RooArgSet()** - * **Parameters** - * ); - * **Return** * **RooArgList \* ConsPDF = new RooArgList()** - * **Parameters** - * ); - * **Return** - + * bool AtLeastOneConstrainFound = false; + * vector SigRooVars = {}; + +* **Functions:** + * SignalType() //default constructor + * [void setSignalType(string sigType, bool FixParams, bool ConstrParams)](#void-signaltype-setsignaltype) //construct from a string + * [vector\ getSigListOfParams()](#vector-signaltype-getsiglistofparams) + * [double getEffSigmaFromResult()](#double-signaltype-geteffsigmafromresult) + * ~SignalType() //default destructor # Functions and their parameters: -### RooRealVar\* getVarFromResult() - -* **Parameters** - * RooFitResult \*fitResult - * string name); -* **Return** - ### void SignalType::setSignalType() +Parses the string sigType and sets the Protected members of the class. * **Parameters** * string sigType * bool FixParams - * bool ConstrParams //construct from a string + * bool ConstrParams * **Return** -### vector SignalType::getSigListOfParams() - -* **Parameters** - * +### vector\ SignalType::getSigListOfParams() * **Return** + * A vector of all variable names from SigRooVars ### double SignalType::getEffSigmaFromResult() - -* **Parameters** - * //Get effective sigma +Depending on the set type of pdf (calculates and) returns the sigma of the gauss/crysta ball. * **Return** + * Effective sigma of the gauss/crysta ball