Skip to main content

Library for calibrating flavour tagging algorithms at LHCb

Project description

lhcb_ftcalib

pipeline status

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lhcb_ftcalib-1.1.2.tar.gz (108.6 kB view details)

Uploaded Source

Built Distribution

lhcb_ftcalib-1.1.2-py3-none-any.whl (66.4 kB view details)

Uploaded Python 3

File details

Details for the file lhcb_ftcalib-1.1.2.tar.gz.

File metadata

  • Download URL: lhcb_ftcalib-1.1.2.tar.gz
  • Upload date:
  • Size: 108.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for lhcb_ftcalib-1.1.2.tar.gz
Algorithm Hash digest
SHA256 900bdbd6d32976d357d914109b01bec968496ec07a1c177547060e29a8725722
MD5 eb52fb422985a04ce3b5eab410f58235
BLAKE2b-256 92c0f00116af01c6fc22803712c2d467c806283e79961d93a5de7dbb88c55140

See more details on using hashes here.

File details

Details for the file lhcb_ftcalib-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: lhcb_ftcalib-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 66.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for lhcb_ftcalib-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5f58dda01a5a2780e4c49afb855dffade2f900f877c96a6b5a6833005424dc7c
MD5 42d173eaec2ff37d902a56cfce930a5c
BLAKE2b-256 6e1091d61b2e650518d1ecfaceb8c01803e05921c651adf9a49fc7678956a3a5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page