Update 'Running the FCNC fitter'

Renata Kopecná 2022-02-03 18:12:47 +01:00
parent 29930c0c6b
commit ca0a0af123

@ -1,3 +1,103 @@
The easiest way to run the FCNC fitter is to use the python wraper `run.py`. The easiest way to run the FCNC fitter is to use the python wraper `run.py`. As the easiest way how to pass arguments to a C++ program is to use single letters, the python wrapper allows a nice quick conversion from running the cryptic C++ code
```
./bu2kstarmumu -r 12 -d 0 -k
```
to rather self explanatory
```
python run.py -Data -Run 12 -convert
```
The possible arguments to add to the runnig script can be listed anytime by running
```
python run.py -h
```
The list is
* -h, --help show this help message and exit
* -v <intVerbosity>, --verbosity <intVerbosity>
Set verbosity level. Default is INFO.
Available levels are:
0: Trace
1: Debug
2: Info
3: Warn
4: Error
5: Critical
* -log <strLog>, --log <strLog>
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>, --Run <Run>
Set the Run number. Default is Run 1.
* -allRun, --allRun Run on Runs 1, 2 and 12.
* -year <year>, --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>, --job <job>
Set the job number
* -evts <evts>, --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>, --bin <bin>
Which angular bin would you like to fit?
* -nBins <nBins>, --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>, --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>, --index <index>
Set index, used for various checks.
* -test <test>, --test <test>
Test parameter. When !=-1, verbosity automatically on debug.
**TODO** **TODO**