Merge pull request #68 from cdunn314/livecount_time

Get live count time and real count time from Compass root file

Author: RemDelaporteMathurin

libra_toolbox/neutron_detection/activation_foils/compass.py

@@ -4,6 +4,7 @@
 import pandas as pd
 from typing import Tuple, Dict
 import datetime
+import uproot
 
 
 def get_channel(filename):
@@ -138,3 +139,18 @@ def get_start_stop_time(directory: str) -> Tuple[datetime.datetime, datetime.dat
         raise ValueError(f"Could not find time.start or time.stop in file {info_file}.")
     else:
         return start_time, stop_time
+
+
+def get_live_time_from_root(filename, channel: int):
+    """
+    Gets live and real count time from Compass root file.
+    Times are given in seconds.
+    Live time is defined as the difference between the actual time that
+    a count is occurring and the "dead time," in which the output of detector
+    pulses is saturated such that additional signals cannot be processed.
+    """
+
+    with uproot.open(filename) as root_file:
+        live_count_time = root_file[f"LiveTime_{channel}"].members["fMilliSec"] / 1000
+        real_count_time = root_file[f"RealTime_{channel}"].members["fMilliSec"] / 1000
+    return live_count_time, real_count_time

pyproject.toml

@@ -15,7 +15,7 @@ description = "Design and analysis tools for LIBRA project"
 license = {file = "LICENSE"}
 requires-python = ">=3.10"
 dynamic = ["version"]
-dependencies = ["numpy", "pint", "scipy", "matplotlib", "sympy", "pandas", "h5py"]
+dependencies = ["numpy", "pint", "scipy", "matplotlib", "sympy", "pandas", "h5py", "uproot"]
 
 [project.optional-dependencies]
 neutronics = ["openmc-data-downloader"]

test/neutron_detection/compass_test_data/times/Hcompass_Co60_20241107.root

@@ -234,3 +234,44 @@ def test_get_start_stop_time_with_notime(tmpdir):
     # run
     with pytest.raises(ValueError, match="Could not find time.start or time.stop"):
         compass.get_start_stop_time(tmpdir2)
+
+
+@pytest.mark.parametrize(
+    "root_filename, channel, live_time, real_time",
+    [
+        (
+            Path(__file__).parent
+            / "compass_test_data/times/Hcompass_Co60_20241107.root",
+            1,
+            808.305,
+            900.108,
+        ),
+        (
+            Path(__file__).parent
+            / "compass_test_data/times/Hcompass_Co60_20241107.root",
+            2,
+            896.374,
+            900.108,
+        ),
+        (
+            Path(__file__).parent
+            / "compass_test_data/times/Hcompass_Zirconium_20250319.root",
+            4,
+            35654.785,
+            39722.502,
+        ),
+        (
+            Path(__file__).parent
+            / "compass_test_data/times/Hcompass_Zirconium_20250319.root",
+            5,
+            39678.458,
+            39722.502,
+        ),
+    ],
+)
+def test_get_live_time_from_root(root_filename, channel, live_time, real_time):
+    live_time_out, real_time_out = compass.get_live_time_from_root(
+        root_filename, channel
+    )
+    assert live_time_out == live_time
+    assert real_time_out == real_time