From 09eb45c1c281edbe399f5dd212fc25f3a53a6ccf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Renata=20Kopecn=C3=A1?= Date: Fri, 4 Feb 2022 10:58:17 +0100 Subject: [PATCH] Update 'Running the FCNC fitter' --- Running-the-FCNC-fitter.md | 129 ++++++++++++++++++------------------- 1 file changed, 63 insertions(+), 66 deletions(-) diff --git a/Running-the-FCNC-fitter.md b/Running-the-FCNC-fitter.md index c16ff8f..0705348 100644 --- a/Running-the-FCNC-fitter.md +++ b/Running-the-FCNC-fitter.md @@ -15,69 +15,66 @@ The possible arguments to add to the runnig script can be listed anytime by runn ``` python run.py -h ``` -| Parameter | Parameter | Parameter description | -|---------------------|----------------------------|---------------------------------------------------------------------------------| -| -h, | --help | show this help message and exit | -| -v \, | --verbosity \ | Set verbosity level. Default is INFO. | -| | | Available levels are: | -| | | 0: Trace | -| | | 1: Debug | -| | | 2: Info | -| | | 3: Warn | -| | | 4: Error | -| | | 5: Critical | -| -log \, | --log \ | Set log file. Default is no log, streaming right into console. | -| -hilfe, | --hilfe | Print full help | -| -compile, | --compile | Compile the code before runing. | -| -dontCompile, | --dontCompile | Don't compile the code before runing. | -| -Run \, | --Run \ | Set the Run number. Default is Run 1 | -| -allRun, | --allRun | Run on Runs 1, 2 and 12 | -| -year \, | --year \ | Run only on one year. | -| -PHSP, | --PHSP | Run on PHSP | -| -Data, | --Data | Run on Data | -| -Ref, | --Ref | Run on reference channel Jpsi | -| -MC, | --MC | Run on signal MC | -| -all, | --all | Run on data, signal MC, reference MC and PHSP | -| -allMC, | --allMC | Run on signal MC, reference MC and PHSP | -| -genMC, | --genMC | Run on generator level MC | -| -boost, | --boost | Run on boosted sample, turn on also generator level MC option! | -| -convert, | --convert | Convert selection tuples to FCNC tuples. | -| -angCorr, | --angCorr | Obtain angular acceptance correction coefficients from PHSP Monte Carlo events. | -| -scan, | --scan | Scan whatever you are doing :) | -| -fit, | --fit | Run the main fit | -| -angRes, | --angRes | Get angular resolution from signal MC. | -| -toys, | --toys | Generate toys. Add -evts to generate custom number of events. | -| -script, | --script | Run whatever script you decided. | -| -job \, | --job \ | Set the job number | -| -evts \, | --evts \ | Set number of used/generated events | -| -onlyBkg, | --onlyBkg | Fit only angular background. | -| -upper, | --upper | Fit only upper-mass side-band. | -| -lower, | --lower | Fit only lower-mass side-band. | -| -bin \, | --bin \ | Which angular bin would you like to fit? | -| -nBins \, | --nBins \ | Set total number q2 bins. | -| -MagDown, | --MagDown | Run only on MagDown | -| -MagUp, | --MagUp | Run only on MagUp | -| -trueMC, | --trueMC | Use MC true information. | -| -likelyhood, | --likelyhood | Likelihood profile scans. | -| -massDim, | --massDim | Fit mass dimension | -| -MoM, | --MoM | Use Method of Moments instead of the fit. | -| -observeP, | --observeP | use P(') angular observables in the fit instead of the S(') | -| -folding \, | --folding \ | Set the folding of angles. | -| | | Five possibilities use range [0-4] | -| | | 0: phi' = phi + pi for phi < 0 | -| | | 1: phi' = -phi for phi < 0 | -| | | phi' = pi - phi for ctl < 0 | -| | | ctl' = -ctl for ctl < 0 | -| | | 2: phi' = -phi for phi < 0 | -| | | ctl' = -ctl for ctl < 0 | -| | | 3: phi' = pi - phi for phi > pi/2 | -| | | phi' = -pi - phi for phi < -pi/2 | -| | | ctl' = -ctl for ctl < 0 | -| | | 4: phi' = pi - phi for phi > pi/2 | -| | | phi' = -pi - phi for phi < -pi/2 | -| | | ctk' = -ctk for ctk < 0 | -| | | ctl' = -ctl for ctl < 0 | -| | | Default is -1, meaning no folding. | -| -loopFolds, | --loopFolds | Evaluate all five foldings | -| -index \, | --index \ | Set index, used for various checks. | -| -test \, | --test \ | Test parameter. When !=-1, verbosity automatically on debug. | + +For the full help printout showing you the arguments when running the code directly from the compiled executable, with nice colors and everything, run + +``` +python run.py -hilfe +``` + +The mandatory parameters are -Run or -year, it will probably not crash immediately if you do not specify the data type, but it is highly recommended. The full list parameters is in this beautiful table + + +| Parameter | Parameter | Parameter description | +|---------------------|----------------------------|---------------------------------------------------------------------| +| -h, | --help | Show this help message **and exit** | +| -v \ | --verbosity \ | Set verbosity level. Default is INFO. | +| | | Available levels are: | +| | | 0: Trace | +| | | 1: Debug | +| | | 2: Info | +| | | 3: Warn | +| | | 4: Error | +| | | 5: Critical | +| -log \ | --log \ | Set log file name. Default is no log, streaming right into console. | +| -hilfe | --hilfe | Print full help directly from the C++ code | +| -compile | --compile | Compile the code. The code is compiled before any running as default, use this option when you want to only compile and nothing else. | +| -dontCompile | --dontCompile | Don't compile the code before runing. The code is compiled before any running as default | +| -Run \ | --Run \ | Set the Run number. Default is Run 1 | +| -allRun | --allRun | Run on Runs 1, 2 and 12 | +| -year \ | --year \ | Run only on one year. | +| -PHSP | --PHSP | Run on PHSP MC | +| -Data | --Data | Run on Data | +| -Ref | --Ref | Run on reference channel (Jpsi Q2). Makes a cut on Q2, so it can be run also with the -Data or PHSP or other data samples | +| -MC | --MC | Run on signal MC | +| -all | --all | Run on data, signal MC, reference MC and PHSP | +| -allMC | --allMC | Run on signal MC, reference MC and PHSP | +| -genMC | --genMC | Run on generator level MC | +| -boost | --boost | Run on boosted sample, turn on also generator level MC option! | +| -convert | --convert | Convert selection tuples to FCNC tuples. This is needed for the FCNC event reader to be able to read the branches. | +| -angCorr | --angCorr | Obtain angular acceptance correction coefficients from PHSP Monte Carlo events. | +| -scan | --scan | Scan whatever you are doing :) Currently effectively only used as an additional option when scanning the order of the polynomial used to describe the angular distributions. | +| -fit | --fit | Run the fit. Depending on the other option the corresponding fit will be executed (eg -fit -MC has different fit model than -fit -Data -Ref) | +| -angRes | --angRes | Get angular resolution from signal MC. | +| -toys | --toys | Generate toys. Add -evts to generate custom number of events. | +| -script | --script | Run whatever script you decided. For more details see [how to run helper scripts](#how-to-run-helper-scripts) | +| -job \ | --job \ | Set the job number (used with toys) | +| -evts \ | --evts \ | Set number of used/generated events | +| -onlyBkg | --onlyBkg | Fit only angular background. | +| -upper | --upper | Fit only upper-mass side-band. | +| -lower | --lower | Fit only lower-mass side-band. | +| -bin \, | --bin \ | Which angular bin would you like to fit? For detials see the [Q2 binning section](https://git.physi.uni-heidelberg.de/kopecna/EWP-BplusToKstMuMu-AngAna/wiki/Home#q2-binning). | +| -nBins \ | --nBins \ | Set total number q2 bins. For detials see the [Q2 binning section](https://git.physi.uni-heidelberg.de/kopecna/EWP-BplusToKstMuMu-AngAna/wiki/Home#q2-binning). | +| -MagDown | --MagDown | Run only on MagDown (possibly broken, as it was not used) | +| -MagUp | --MagUp | Run only on MagUp (possibly broken, as it was not used) | +| -trueMC | --trueMC | Use MC true information, obsolete option, don't use | +| -likelyhood | --likelyhood | Likelihood profile scans. It is not working as we never got to it, but it is kept for legacy reasons | +| -massDim | --massDim | Fit mass dimension only. | +| -MoM | --MoM | Use Method of Moments instead of the fit. It is not working as we never got to it, but it is kept for legacy reasons | +| -observeP | --observeP | use P(') angular observables in the fit instead of the S(') It is not working as we never got to it, but it is kept for legacy reasons | +| -folding \ | --folding \ | Set the folding of angles. | +| | | Five possibilities, use range [0-4]. For details see the [angular folding section](https://git.physi.uni-heidelberg.de/kopecna/EWP-BplusToKstMuMu-AngAna/wiki/Home#angular-folding). | +| | | Default is -1, meaning no folding. | +| -loopFolds | --loopFolds | Evaluate all five foldings | +| -index \ | --index \ | Set index, used for various checks. | +| -test \ | --test \ | Test parameter, used when testing some new functionality in development. When !=-1, verbosity automatically on debug. |