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
  • uncertainties
  • numba

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

Uploaded Source

Built Distribution

lhcb_ftcalib-0.1.4-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lhcb_ftcalib-0.1.4.tar.gz
  • Upload date:
  • Size: 118.5 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

Hashes for lhcb_ftcalib-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9f2deb1678bc95b71e0594328124f634f94b733e57951a0dbe8fcb7b97fade81
MD5 abd9cd7e1f8e1b42e38c8b287109e9d0
BLAKE2b-256 5dffe86afe140cb90694925b852e3457eb1a3bcf10b26c9b4702495e0efc3fe9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lhcb_ftcalib-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 57.2 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

Hashes for lhcb_ftcalib-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 715a3566df21747dc67fd78464348229ec5b7cb79e52cc9810e225a32bb67cd1
MD5 47f15a50b47a84b46d7a2e576506e7e7
BLAKE2b-256 ed6502da90b04ff02cd604a234e3ed0c469eb8db8846904117ff5c8d901b7b91

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