diff --git a/MassFit.cpp.md b/MassFit.cpp.md index 4841a50..2d999eb 100644 --- a/MassFit.cpp.md +++ b/MassFit.cpp.md @@ -1,29 +1,52 @@ - # Classes ### TMefficiencyClass -* **Private members:** * **Public members:** - * string sVariable - * std::vector\sBranchName - * Int_t Bins - * Float_t Range\[2\] - * std::vector\> vVarRange - * std::vector\ binEdges - * std::vector\ binEdgesEquidistant - * bool isEquidistant - * Float_t Step - * string cut - * +| Name | Description | +| ------------- | ------------- | +| string sVariable | LaTeX name of the parameter | +| std::vector\sBranchName | | +| Int_t Bins | | +| Float_t Range\[2\] | | +| std::vector\> vVarRange | | +| std::vector\ binEdges | | +| std::vector\ binEdgesEquidistant | | +| bool isEquidistant | | +| Float_t Step | | +| string cut | | + + * **Functions:** - * **TMefficiencyClass()** - * **Parameters** - * //default constructor - * **Return** + * void fillBinEdges() **TODO** add links + * void isEq(string &varName) + * bool check_vector_size(bool isEqui) + * TMefficiencyClass() //full constructor + * ~TMefficiencyClass() //default destuctor # Functions and their parameters: +### TMefficiencyClass::TMefficiencyClass() +Constructor of the TMefficiencyClass. Based on the varName input parameter, it sets the + +* **Parameters** + * string varName + +### void TMefficiencyClass::fillBinEdges() +Takes the TM efficiency class nad based on the number of bins and the overall bin range fills `binEdgesEquidistant` + +### void TMefficiencyClass::isEq() +Checks whether the varName parameter contains string "\_equal" if yes, sets `isEquidistant` to true and remove the "\_equal" from the varName. +* **Parameters** + * string &varName + +### bool TMefficiencyClass::check_vector_size() +Checks whether the size of the binEdges (or binEdgesEqudistant if isEquidistant is true) array is equal to nBins+1. +* **Parameters** + * bool isEqui +* **Return** + * True if everything is okay, False if the bin-edge array size is not equal to nBins+1. + ### bool useExtraVarBool() This functions checks whether the used extra variable is listed in the binning scheme defined in the TMefficiencyClass. **ṪODO** add a link