Library for calibrating flavour tagging algorithms at LHCb
Project description
lhcb_ftcalib
LHCb Flavour Tagging calibration software
At high-energy proton-proton collider experiments, the production flavour of neutral B mesons needs to be reconstructed from particle charges from hadronisation processes in the associated event, i.e. from additional hadronisations on the signal meson side, as well as hadronisation and decays of the partner B hadron. This is commonly done with ML techniques like (recurrent) neural networks or boosted decision trees. The mistag probability estimates of these models (probability that predicted production flavour is wrong) usually need to have the property of probabilities. This calibration tool optimizes a GLM function to predict the mistag probabilities and takes into account the fact that neutral mesons can undergo oscillation before they decay. In addition, it provides helper functions to measure the performance and correlations of these models.
Documentation: Read the Docs
Installation
pip install lhcb_ftcalib
Command Line Interface Examples
Run ftcalib --help
for a list of all options or read the docs
1. Calibrating opposite side taggers in a sample and saving result
ftcalib file:tree -OS VtxCh Charm OSElectronLatest OSMuonLatest OSKaonLatest \
-mode Bd -tau B_tau -id B_ID -op calibrate -out output
2. Calibrating both tagging sides, combining them inidividually, and calibrating+saving the results
ftcalib file:tree -OS VtxCh Charm OSElectronLatest OSMuonLatest OSKaonLatest \
-SS SSPion SSProton \
-mode Bd -tau B_tau -id B_ID -op calibrate combine calibrate -out output
Note: The command line interface is by design not feature complete. Use the API to fine tune the calibration settings.
Requirements
- uproot >= 4
- iminuit >= 2.3.0
- pandas
- numpy
- scipy
- matplotlib
- numba == 0.53.1
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file lhcb_ftcalib-1.1.1.tar.gz
.
File metadata
- Download URL: lhcb_ftcalib-1.1.1.tar.gz
- Upload date:
- Size: 109.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e881e429d070ce03ae6cf946cbcf5e64d4ec569cfdb442490bc4381b3c32e70 |
|
MD5 | db38c9ffa94aee73edf61415cc3735ba |
|
BLAKE2b-256 | cc7bb6002337ec9e1a96941587ff6db61316d5a46be8231d77fdf88270b99de5 |
File details
Details for the file lhcb_ftcalib-1.1.1-py3-none-any.whl
.
File metadata
- Download URL: lhcb_ftcalib-1.1.1-py3-none-any.whl
- Upload date:
- Size: 66.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cff088444cd4613198c073d8a900cf40f8ddb607f6b63fdd487944e295a99ad7 |
|
MD5 | b02080254eecb20502ce0465636b33ab |
|
BLAKE2b-256 | 13934d05b5d48aa841c6a2b0c0240e324b102e4addef4ead2571709e9b860e1b |