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.4.tar.gz (109.1 kB view details)

Uploaded Source

Built Distribution

lhcb_ftcalib-1.1.4-py3-none-any.whl (66.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lhcb_ftcalib-1.1.4.tar.gz
  • Upload date:
  • Size: 109.1 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.4.tar.gz
Algorithm Hash digest
SHA256 9f73fd291f71f2f6f57410f81ca77f0c4cd55041de7bc5a8ed1673c745af1540
MD5 8d3667b213b59e5e092e4bd11089e862
BLAKE2b-256 130068ece7f91c63e66717d8b9e492a17c598a3d288222015da5e9caba28016b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lhcb_ftcalib-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 66.7 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c9ea39e694df04be6f1d38401b2458478be87875840d03db8e2626e4553ab5b7
MD5 c81352adfc58a9480b112b58c9159975
BLAKE2b-256 905cb93d9ea1cdc9ef149f05d266afa7eb423f0094747f302201bc0647b96ce4

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