atlas-ftag-tools 0.1.19__py3-none-any.whl → 0.2.1__py3-none-any.whl

{atlas_ftag_tools-0.1.19.dist-info → atlas_ftag_tools-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atlas-ftag-tools
-Version: 0.1.19
+Version: 0.2.1
 Summary: ATLAS Flavour Tagging Tools
 Author: Sam Van Stroud, Philipp Gadow
 License: MIT

atlas_ftag_tools-0.2.1.dist-info/RECORD

@@ -0,0 +1,26 @@
+ftag/__init__.py,sha256=aCC6idmHdlETdgAFN4PeESN67WpeVqo85Nledw9VkH4,629
+ftag/cli_utils.py,sha256=w3TtQmUHSyAKChS3ewvOtcSDAUJAZGIIomaNi8f446U,298
+ftag/cuts.py,sha256=a0BJj4cVRunc-hFLPloGvNoSFvRmZg2kVLv7sA0iAaI,2817
+ftag/flavour.py,sha256=qvgp4DarOdcQgjae_NWnd81k_YqdmFY74lOKky2lpb8,3568
+ftag/flavours.yaml,sha256=h0A2cw-je1oCe-rh5qhuL1BhDNhu2aLkf7W9y-Cpy3g,6959
+ftag/git_check.py,sha256=Y-XqM80CVXZ5ZKrDdZcYOJt3X64uU6W3OP6Z0D7AZU0,1663
+ftag/mock.py,sha256=9V6sAT4_t-rhR67q9KHaj1NKAeqU7lQjWxiOxEzk8Sw,4338
+ftag/region.py,sha256=ANv0dGI2W6NJqD9fp7EfqAUReH4FOjc1gwl_Qn8llcM,360
+ftag/sample.py,sha256=TFXMhDkbPmjkms9-b-bINJ32T3bO86JcU70C0nY7wa8,2500
+ftag/test_cli_utils.py,sha256=xa08vf6SEOow58SSFagYdAselb-dkNOVvWsWheMnW-g,1001
+ftag/transform.py,sha256=uEGGJSnqoKOzLYQv650XdK_kDNw4Aw-5dc60z9Dp_y0,3963
+ftag/vds.py,sha256=nRViQZQIORB95nC7NZsW3KsSoGkLzEdOsuCViH5h8-U,3296
+ftag/hdf5/__init__.py,sha256=LFDNxVOCp58SvLHwQhdT68Q-KBMS_i6jBrbXoRpHzbM,354
+ftag/hdf5/h5move.py,sha256=oYpRu0IDCIJIQ2ML52HBAdoyDxmKkHTeM9JdbPEgKfI,947
+ftag/hdf5/h5reader.py,sha256=et-_LXt942xegqc14bPapUgIO7MUfC2m04uJslLkXxI,13579
+ftag/hdf5/h5split.py,sha256=4Wy6Xc3J58MdD9aBaSZHf5ZcVFnJSkWsm42R5Pgo-R4,2448
+ftag/hdf5/h5utils.py,sha256=-4zKTMtNCrDZr_9Ww7uzfsB7M7muBKpmm_1IkKJnHOI,3222
+ftag/hdf5/h5writer.py,sha256=wVyurIgfSBtvZTX-v0v3R5-8JOwWK_yF1rUX-RewXzY,4826
+ftag/wps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ftag/wps/discriminant.py,sha256=c2-bal124yY1rZjK87iQHb9RRo4pus6SVue6SfMKrRY,3749
+ftag/wps/working_points.py,sha256=VTU6OD40ULAJQD0MlD1EZd33q8ociUvFX1YrhgJFvXc,9722
+atlas_ftag_tools-0.2.1.dist-info/METADATA,sha256=KpKapru-RWOoq01J5sm04jE2brwpoPxDGVPTZoppl8c,5168
+atlas_ftag_tools-0.2.1.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
+atlas_ftag_tools-0.2.1.dist-info/entry_points.txt,sha256=LfVLsZHQolqbPnwPgtmc5IQTh527BKkN2v-IpXWTNHw,137
+atlas_ftag_tools-0.2.1.dist-info/top_level.txt,sha256=qiYQuKcAvMim-31FwkT3MTQu7WQm0s58tPAia5KKWqs,5
+atlas_ftag_tools-0.2.1.dist-info/RECORD,,

{atlas_ftag_tools-0.1.19.dist-info → atlas_ftag_tools-0.2.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (70.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ftag/__init__.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-__version__ = "v0.1.19"
+__version__ = "v0.2.1"
 
 
 from ftag import hdf5

ftag/cli_utils.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+import argparse
+from pathlib import Path
+
+
+def valid_path(string):
+    if (path := Path(string)).is_file():
+        return path
+    raise FileNotFoundError(string)
+
+
+class HelpFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter): ...

ftag/flavours.yaml

@@ -140,37 +140,84 @@
   colour: "#e76f51"
   category: lepton-decay
 
+# PDGID labelling: taken from https://pdg.lbl.gov/2023/reviews/rpp2023-rev-monte-carlo-numbering.pdf
+- name: D0meson
+  label: $D^0$ in $c$-jet
+  cuts: ["HadronConeExclTruthLabelID == 4", "HadronConeExclTruthLabelPdgId in (421,-421)"]
+  colour: "#FFA500"
+  category: PDGID
+- name: nonD0meson
+  label: $D^+$, $Ds^+$ or baryon in $c$-jet
+  cuts: ["HadronConeExclTruthLabelID == 4", "HadronConeExclTruthLabelPdgId notin (421,-421)"]
+  colour: "#800080"
+  category: PDGID
+- name: Dplusmeson
+  label: $D^+$ in $c$-jet
+  cuts: ["HadronConeExclTruthLabelID == 4", "HadronConeExclTruthLabelPdgId in (411,-411)"]
+  colour: "#00FFFF"
+  category: PDGID
+- name: Dsplusmeson
+  label: $Ds^+$ in $c$-jet
+  cuts: ["HadronConeExclTruthLabelID == 4", "HadronConeExclTruthLabelPdgId in (431,-431)"]
+  colour: "#781DC8"
+  category: PDGID
+- name: B0meson
+  label: $B^0$ in $b$-jet
+  cuts: ["HadronConeExclTruthLabelID == 5", "HadronConeExclTruthLabelPdgId in (511,-511)"]
+  colour: "#702B1C"
+  category: PDGID
+- name: Bplusmeson
+  label: $B^0$ in $b$-jet
+  cuts: ["HadronConeExclTruthLabelID == 5", "HadronConeExclTruthLabelPdgId in (521,-521)"]
+  colour: "#C81D4A"
+  category: PDGID
+- name: Bs0meson
+  label: $Bs^0$ in $b$-jet
+  cuts: ["HadronConeExclTruthLabelID == 5", "HadronConeExclTruthLabelPdgId in (531,-531)"]
+  colour: "#1D62C8"
+  category: PDGID
+
 # lepton isolation
 ## taken from https://gitlab.cern.ch/atlas/athena/-/blob/main/PhysicsAnalysis/AnalysisCommon/TruthClassification/README.md#4-details-about-the-lepton-categories
 - name: elxprompt
   label: prompt electrons
-  cuts: ["iffClass == 2"]
+  cuts: ["iffClass in (2,3)"]
   colour: tab:red
   category: isolation
+- name: elxnoflip
+  label: prompt electrons with no charge-flip
+  cuts: ["iffClass == 2"]
+  colour: darkorange
+  category: isolation
 - name: elxflip
   label: prompt electrons with charge-flip
   cuts: ["iffClass == 3"]
   colour: tab:orange
   category: isolation
+- name: elxphconv
+  label: electrons from prompt photon-conversions
+  cuts: ["iffClass == 5"]
+  colour: tab:purple
+  category: isolation
+- name: elxnonprompt
+  label: non-prompt electrons
+  cuts: ["iffClass notin (2,3,5)"]
+  colour: "#264653"
+  category: isolation
 - name: muxprompt
   label: prompt muons
-  cuts: ["iffClass == 4"]
+  cuts: ["iffClass in (4,11)"]
   colour: tab:blue
   category: isolation
+- name: muxnoflip
+  label: prompt muons with no charge-flip
+  cuts: ["iffClass == 4"]
+  colour: aqua
+  category: isolation
 - name: muxflip
   label: prompt muons with charge-flip
   cuts: ["iffClass == 11"]
-  colour: aqua
-  category: isolation
-- name: elxphconv
-  label: electrons from prompt photon-conversions
-  cuts: ["iffClass == 5"]
-  colour: tab:purple
-  category: isolation
-- name: elxfrommu
-  label: electrons from muons
-  cuts: ["iffClass == 6"]
-  colour: salmon
+  colour: midnightblue
   category: isolation
 - name: npxall
   label: non-prompt lepton

ftag/hdf5/h5move.py

@@ -3,14 +3,15 @@
 from __future__ import annotations
 
 import argparse
-from pathlib import Path
 
 import h5py
 
+from ftag.cli_utils import HelpFormatter, valid_path
+
 
 def parse_args(args):
-    parser = argparse.ArgumentParser(description=__doc__)
-    parser.add_argument("--fname", required=True, type=Path, help="path to h5 file")
+    parser = argparse.ArgumentParser(description=__doc__, formatter_class=HelpFormatter)
+    parser.add_argument("--fname", required=True, type=valid_path, help="path to h5 file")
     parser.add_argument(
         "--src",
         required=True,

ftag/hdf5/h5split.py

@@ -7,12 +7,10 @@ from pathlib import Path
 
 import h5py
 
+from ftag.cli_utils import HelpFormatter
 from ftag.hdf5 import H5Reader, H5Writer
 
 
-class HelpFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter): ...
-
-
 def parse_args(args):
     parser = argparse.ArgumentParser(description=__doc__, formatter_class=HelpFormatter)
     parser.add_argument("--src", required=True, type=Path, help="path to source h5 file")

ftag/test_cli_utils.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from pathlib import Path
+from tempfile import NamedTemporaryFile, TemporaryDirectory
+
+import pytest
+
+from ftag.cli_utils import valid_path
+
+
+def test_valid_path_existing_file():
+    # Test when the input path is an existing file
+    # get a temp directory
+    with TemporaryDirectory() as tmpdir, NamedTemporaryFile(dir=tmpdir) as f:
+        input_path = f.name
+        expected_output = Path(f.name)
+        result = valid_path(input_path)
+        assert result == expected_output
+
+
+def test_valid_path_non_existing_file():
+    # Test when the input path is a non-existing file
+    input_path = "non_existing_file.txt"
+    with pytest.raises(FileNotFoundError) as e:
+        valid_path(input_path)
+    assert str(e.value) == input_path
+
+
+def test_valid_path_directory():
+    # Test when the input path is a directory
+    input_path = "directory/"
+    with pytest.raises(FileNotFoundError) as e:
+        valid_path(input_path)
+    assert str(e.value) == input_path

ftag/wps/discriminant.py

@@ -53,6 +53,11 @@ def discriminant(
     return np.log((jets[f"{tagger}_{signal.px}"] + epsilon) / (denominator + epsilon))
 
 
+def tautag_dicriminant(jets, tagger, fb, fc, epsilon=1e-10):
+    fxs = {"pb": fb, "pc": fc, "pu": 1 - fb - fc}
+    return discriminant(jets, tagger, Flavours.taujets, fxs, epsilon=epsilon)
+
+
 def btag_discriminant(jets, tagger, fc, ftau=0, epsilon=1e-10):
     fxs = {"pc": fc, "ptau": ftau, "pu": 1 - fc - ftau}
     return discriminant(jets, tagger, Flavours.bjets, fxs, epsilon=epsilon)
@@ -99,6 +104,7 @@ def get_discriminant(
     tagger_funcs: dict[str, Callable] = {
         "bjets": btag_discriminant,
         "cjets": ctag_discriminant,
+        "taujets": tautag_dicriminant,
         "hbb": hbb_discriminant,
         "hcc": hcc_discriminant,
     }

ftag/wps/working_points.py

@@ -1,3 +1,5 @@
+"""Calculate tagger working points."""
+
 from __future__ import annotations
 
 import argparse
@@ -6,6 +8,7 @@ from pathlib import Path
 import numpy as np
 import yaml
 
+from ftag.cli_utils import HelpFormatter
 from ftag.cuts import Cuts
 from ftag.flavour import Flavours
 from ftag.hdf5 import H5Reader
@@ -14,8 +17,8 @@ from ftag.wps.discriminant import get_discriminant
 
 def parse_args(args):
     parser = argparse.ArgumentParser(
-        description="Calculate tagger working points",
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        description=__doc__,
+        formatter_class=HelpFormatter,
     )
     parser.add_argument(
         "--ttbar",

atlas_ftag_tools-0.1.19.dist-info/RECORD

@@ -1,24 +0,0 @@
-ftag/__init__.py,sha256=ejpCAn-ZuVi3dfPhvdyw4qDs9m6S5hgpWe3jPIh8fGE,630
-ftag/cuts.py,sha256=a0BJj4cVRunc-hFLPloGvNoSFvRmZg2kVLv7sA0iAaI,2817
-ftag/flavour.py,sha256=qvgp4DarOdcQgjae_NWnd81k_YqdmFY74lOKky2lpb8,3568
-ftag/flavours.yaml,sha256=9ifKyz1_VoHlOaWuf3JEqMLSYyLFedYJf9x1D6dCTnM,5335
-ftag/git_check.py,sha256=Y-XqM80CVXZ5ZKrDdZcYOJt3X64uU6W3OP6Z0D7AZU0,1663
-ftag/mock.py,sha256=9V6sAT4_t-rhR67q9KHaj1NKAeqU7lQjWxiOxEzk8Sw,4338
-ftag/region.py,sha256=ANv0dGI2W6NJqD9fp7EfqAUReH4FOjc1gwl_Qn8llcM,360
-ftag/sample.py,sha256=TFXMhDkbPmjkms9-b-bINJ32T3bO86JcU70C0nY7wa8,2500
-ftag/transform.py,sha256=uEGGJSnqoKOzLYQv650XdK_kDNw4Aw-5dc60z9Dp_y0,3963
-ftag/vds.py,sha256=nRViQZQIORB95nC7NZsW3KsSoGkLzEdOsuCViH5h8-U,3296
-ftag/hdf5/__init__.py,sha256=LFDNxVOCp58SvLHwQhdT68Q-KBMS_i6jBrbXoRpHzbM,354
-ftag/hdf5/h5move.py,sha256=1I4V6hUu2cPZbsvIPPpcjBWW96w286U9VOt_PbcHr9Q,881
-ftag/hdf5/h5reader.py,sha256=et-_LXt942xegqc14bPapUgIO7MUfC2m04uJslLkXxI,13579
-ftag/hdf5/h5split.py,sha256=qvZzZTBHYOjHDbiuoPZpJv-YK_4wmkVDryBU6iBle9I,2505
-ftag/hdf5/h5utils.py,sha256=-4zKTMtNCrDZr_9Ww7uzfsB7M7muBKpmm_1IkKJnHOI,3222
-ftag/hdf5/h5writer.py,sha256=wVyurIgfSBtvZTX-v0v3R5-8JOwWK_yF1rUX-RewXzY,4826
-ftag/wps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ftag/wps/discriminant.py,sha256=J2Cst9slZCLoHZYTeltQSmN1Uoa8GUX529rwNlHmyfI,3519
-ftag/wps/working_points.py,sha256=0XrA-h6M3mdn5qwkdoizQtAhmrUxbKV22l4sBfVoxAE,9692
-atlas_ftag_tools-0.1.19.dist-info/METADATA,sha256=lCWhyEJI8HG1hj_8oQRza_7tESH-_XuCnOLdChZAY4Q,5169
-atlas_ftag_tools-0.1.19.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-atlas_ftag_tools-0.1.19.dist-info/entry_points.txt,sha256=LfVLsZHQolqbPnwPgtmc5IQTh527BKkN2v-IpXWTNHw,137
-atlas_ftag_tools-0.1.19.dist-info/top_level.txt,sha256=qiYQuKcAvMim-31FwkT3MTQu7WQm0s58tPAia5KKWqs,5
-atlas_ftag_tools-0.1.19.dist-info/RECORD,,