reboost 0.6.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

reboost/utils.py

@@ -9,6 +9,7 @@ from collections.abc import Iterable, Mapping
 from contextlib import contextmanager
 from pathlib import Path
 
+import h5py
 from dbetto import AttrsDict
 from lgdo import lh5
 from lgdo.types import Struct, Table, VectorOfVectors
@@ -51,7 +52,9 @@ def get_wo_mode(
     chunk
         the chunk index
     new_hit_file
-        a flag of whether we are writing a new hit file
+        a flag of whether we are writing a new hit file. This does not indicate whether
+        the file already exists on disk, but whether the file name is different from the
+        last written chunk for this detector.
     overwrite
         a flag of whether to overwrite the old file.
 
@@ -75,6 +78,49 @@ def get_wo_mode(
     return "append"
 
 
+def get_wo_mode_forwarded(
+    written_tables: set[str], new_hit_file: bool, overwrite: bool = False
+) -> str:
+    """Get the mode for lh5 file writing for forwarded tables tahat will be copied without chunking.
+
+    If we are writing a new output file and no other tables had been written yet, then
+    the mode "overwrite_file" is used if the overwrite flag is set, otherwise the mode
+    "write_safe" is used.
+
+    Otherwise "append" is used.
+
+    Parameters
+    ----------
+    written_tables
+        a set of already written table names, also including other table names of
+        non-forwarded (i.e. processed) tables.
+    new_hit_file
+        a flag of whether we are writing a new hit file. This does not indicate whether
+        the file already exists on disk, but whether the file name is different from the
+        last written chunk for this forwarded table.
+    overwrite
+        a flag of whether to overwrite the old file.
+
+    Returns
+    -------
+    the mode for IO
+    """
+    if not new_hit_file:
+        return "append"
+    if overwrite and len(written_tables) == 0:
+        return "overwrite_file"
+    return "write_safe"
+
+
+def is_new_hit_file(files: AttrsDict, file_idx: int) -> bool:
+    """Return whether the hit file with the given index is a "new" hit file.
+
+    A new file is either the first file written, or when the previous file index has a
+    different file name.
+    """
+    return (file_idx == 0) or (files.hit[file_idx] != files.hit[file_idx - 1])
+
+
 def get_file_dict(
     stp_files: list[str] | str,
     glm_files: list[str] | str | None,
@@ -119,7 +165,7 @@ def get_file_dict(
     files = {}
 
     for file_type, file_list in zip(
-        ["stp", "glm", "hit"], [stp_files, glm_files_list, hit_files_list]
+        ["stp", "glm", "hit"], [stp_files, glm_files_list, hit_files_list], strict=True
     ):
         if isinstance(file_list, str):
             files[file_type] = [file_list]
@@ -258,7 +304,10 @@ def get_function_string(expr: str, aliases: dict | None = None) -> tuple[str, di
             globs = globs | {
                 package: importlib.import_module(package_import),
             }
-        except Exception:
+        except Exception as e:
+            # for imports of our own package, raise the error back to the user
+            if package_import == "reboost":
+                raise e
             msg = f"Function {package_import} cannot be imported"
             log.debug(msg)
             continue
@@ -394,3 +443,61 @@ def write_lh5(
         )
     if time_dict is not None:
         time_dict.update_field("write", start_time)
+
+
+def get_remage_detector_uids(h5file: str | Path) -> dict:
+    """Get mapping of detector names to UIDs from a remage output file.
+
+    The remage LH5 output files contain a link structure that lets the user
+    access detector tables by UID. For example:
+
+    .. code-block:: text
+
+        ├── stp · struct{det1,det2,optdet1,optdet2,scint1,scint2}
+        └── __by_uid__ · struct{det001,det002,det011,det012,det101,det102}
+            ├── det001 -> /stp/scint1
+            ├── det002 -> /stp/scint2
+            ├── det011 -> /stp/det1
+            ├── det012 -> /stp/det2
+            ├── det101 -> /stp/optdet1
+            └── det102 -> /stp/optdet2
+
+    This function analyzes this structure and returns:
+
+    .. code-block:: text
+
+        {1: 'scint1',
+         2: 'scint2',
+         11: 'det1',
+         12: 'det2',
+         101: 'optdet1',
+         102: 'optdet2'g
+
+    Parameters
+    ----------
+    h5file
+        path to remage output file.
+    """
+    if isinstance(h5file, Path):
+        h5file = h5file.as_posix()
+
+    out = {}
+    with h5py.File(h5file, "r") as f:
+        g = f["/stp/__by_uid__"]
+        # loop over links
+        for key in g:
+            # is this a link?
+            link = g.get(key, getlink=True)
+            if isinstance(link, h5py.SoftLink):
+                m = re.fullmatch(r"det(\d+)", key)
+                if m is None:
+                    msg = rf"'{key}' is not formatted as expected, i.e. 'det(\d+)', skipping"
+                    log.warning(msg)
+                    continue
+
+                # get the name of the link target without trailing groups (to
+                # i.e. remove /stp)
+                name = link.path.split("/")[-1]
+
+                out[int(m.group(1))] = name
+    return out

{reboost-0.6.1.dist-info → reboost-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reboost
-Version: 0.6.1
+Version: 0.7.0
 Summary: New LEGEND Monte-Carlo simulation post-processing
 Author-email: Manuel Huber <info@manuelhu.de>, Toby Dixon <toby.dixon.23@ucl.ac.uk>, Luigi Pertoldi <gipert@pm.me>
 Maintainer: The LEGEND Collaboration
@@ -693,7 +693,7 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: hdf5plugin
@@ -701,8 +701,8 @@ Requires-Dist: colorlog
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: numba
-Requires-Dist: legend-pydataobj>=1.14
-Requires-Dist: legend-pygeom-optics>=0.9.2
+Requires-Dist: legend-pydataobj>=1.15.1
+Requires-Dist: legend-pygeom-optics>=0.12.0
 Requires-Dist: legend-pygeom-tools>=0.0.11
 Requires-Dist: hist
 Requires-Dist: dbetto

reboost-0.7.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+reboost/__init__.py,sha256=VZz9uo7i2jgAx8Zi15SptLZnE_qcnGuNWwqkD3rYHFA,278
+reboost/_version.py,sha256=uLbRjFSUZAgfl7V7O8zKV5Db36k7tz87ZIVq3l2SWs0,704
+reboost/build_evt.py,sha256=VXIfK_pfe_Cgym6gI8dESwONZi-v_4fll0Pn09vePQY,3767
+reboost/build_glm.py,sha256=IerSLQfe51ZO7CQP2kmfPnOIVaDtcfw3byOM02Vaz6o,9472
+reboost/build_hit.py,sha256=pjEaiPW63Q3MfpjI29uJXx9gtwfiOIgOcADRDrDpRrA,17409
+reboost/cli.py,sha256=68EzKiWTHJ2u1RILUv7IX9HaVq6nTTM80_W_MUnWRe4,6382
+reboost/core.py,sha256=wIIDxaPzEaozZOeKabz4l-29_IyY47RbNy6qS8Bai1Y,15297
+reboost/iterator.py,sha256=qlEqRv5qOh8eIs-dyVOLYTvH-ZpQDx9fLckpcAdtWjs,6975
+reboost/log_utils.py,sha256=VqS_9OC5NeNU3jcowVOBB0NJ6ssYvNWnirEY-JVduEA,766
+reboost/profile.py,sha256=EOTmjmS8Rm_nYgBWNh6Rntl2XDsxdyed7yEdWtsZEeg,2598
+reboost/units.py,sha256=LUwl6swLQoG09Rt9wcDdu6DTrwDsy-C751BNGzX4sz8,3651
+reboost/utils.py,sha256=SfrqWdQZPNXw0x0DVucxHC5OwFXewM43tO-PNnIwjKI,14562
+reboost/daq/__init__.py,sha256=rNPhxx1Yawt3tENYhmOYSum9_TdV57ZU5kjxlWFAGuo,107
+reboost/daq/core.py,sha256=Rs6Q-17fzEod2iX_2WqEmnqKnNRFoWTYURl3wYhFihU,9915
+reboost/daq/utils.py,sha256=KcH6zvlInmD2YiF6V--DSYBTYudJw3G-hp2JGOcES2o,1042
+reboost/hpge/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+reboost/hpge/psd.py,sha256=P9lxji4njwFwPBR0vfh6gkvt7GQx2BRajvCsUUmtEqU,24407
+reboost/hpge/surface.py,sha256=ROewOsSoq8zRAaiamWdMDl-UR7ZfsimgH2Lv9k0flKg,8494
+reboost/hpge/utils.py,sha256=AcMS86v8s0SbeC4YA3CfH73GBZcC7Sb_RR3pRPjWAwU,2857
+reboost/math/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+reboost/math/functions.py,sha256=OymiYTcA0NXxxm-MBDw5kqyNwHoLCmuv4J48AwnSrbU,5633
+reboost/math/stats.py,sha256=Rq4Wdzv-3aoSK7EsPZCuOEHfnOz3w0moIzCEHbC07xw,3173
+reboost/optmap/__init__.py,sha256=imvuyld-GLw8qdwqW-lXCg2feptcTyQo3wIzPvDHwmY,93
+reboost/optmap/cli.py,sha256=CoH0P_WLEek1T9zxmlsM2TuxxzqobP-W-ym72uhxrO4,10252
+reboost/optmap/convolve.py,sha256=9fM5zVKkwp03a3kqBwWppe1UOGdVm1Q6yF4P0v2I8VQ,22936
+reboost/optmap/create.py,sha256=qwUvYiUotmLCrB6RsfwxRMGI4EYRn7Q4XlwppUTVZTE,18166
+reboost/optmap/evt.py,sha256=UrjjNNeS7Uie4Ah9y_f5PyroFutLGo5aOFcwReOEy7o,5556
+reboost/optmap/mapview.py,sha256=73kpe0_SKDj9bIhEx1ybX1sBP8TyvufiLfps84A_ijA,6798
+reboost/optmap/numba_pdg.py,sha256=y8cXR5PWE2Liprp4ou7vl9do76dl84vXU52ZJD9_I7A,731
+reboost/optmap/optmap.py,sha256=f8Y0zLmXZyOz4-GDUPViIY_vf_shY3ZQG9lSD31J8gc,12820
+reboost/shape/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+reboost/shape/cluster.py,sha256=nwR1Dnf00SDICGPqpXeM1Q7_DwTtO9uP3wmuML45c3g,8195
+reboost/shape/group.py,sha256=gOCYgir2gZqmW1JXtbNRPlQqP0gmUcbe7RVb9CbY1pU,5540
+reboost/shape/reduction.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+reboost/spms/__init__.py,sha256=ffi0rH-ZFGmpURbFt-HY1ZAHCdady0mLXNsblRNh-JY,207
+reboost/spms/pe.py,sha256=9KWmc4fGW5_bx4imsguLm-xp6rokt89iZcM-WD62Tj4,3090
+reboost-0.7.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+reboost-0.7.0.dist-info/METADATA,sha256=-CFo2D7zHSJXcSsfMQtXIv8T4nx3qoR4OMD6EbaKLU0,44226
+reboost-0.7.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+reboost-0.7.0.dist-info/entry_points.txt,sha256=DxhD6BidSWNot9BrejHJjQ7RRLmrMaBIl52T75oWTwM,93
+reboost-0.7.0.dist-info/top_level.txt,sha256=q-IBsDepaY_AbzbRmQoW8EZrITXRVawVnNrB-_zyXZs,8
+reboost-0.7.0.dist-info/RECORD,,

reboost-0.6.1.dist-info/RECORD

@@ -1,37 +0,0 @@
-reboost/__init__.py,sha256=VZz9uo7i2jgAx8Zi15SptLZnE_qcnGuNWwqkD3rYHFA,278
-reboost/_version.py,sha256=a3_WODLDfpmAw3pMw7qGqmRuXHTCC3STyQd2R1iEOgA,511
-reboost/build_evt.py,sha256=VXIfK_pfe_Cgym6gI8dESwONZi-v_4fll0Pn09vePQY,3767
-reboost/build_glm.py,sha256=IerSLQfe51ZO7CQP2kmfPnOIVaDtcfw3byOM02Vaz6o,9472
-reboost/build_hit.py,sha256=23JL5B7qThdHZqAK_HWoytqcEOWDhGsk4n5UMtojJ1c,15513
-reboost/cli.py,sha256=HZgqUZK0tSmnlGqoXjrbmLitW_i001TzibxvDrRxLLg,6324
-reboost/core.py,sha256=WGbWe2rcfMDEaehVyw7peqAHoTFWoCu5J6CdWHC5aWA,14974
-reboost/iterator.py,sha256=fATFDxu2PUc0e48OdJJujZo2kwykfRLH1oBtcB-s5pM,6905
-reboost/log_utils.py,sha256=VqS_9OC5NeNU3jcowVOBB0NJ6ssYvNWnirEY-JVduEA,766
-reboost/profile.py,sha256=EOTmjmS8Rm_nYgBWNh6Rntl2XDsxdyed7yEdWtsZEeg,2598
-reboost/units.py,sha256=3EH8XlpbsObdu5vLgxhm1600L6UNYD5jng4SjJT_1QE,2202
-reboost/utils.py,sha256=WT2jlyRT3LEMBEBRJtYIat3KIIZKocv4rHlTViBbhYM,10938
-reboost/hpge/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reboost/hpge/psd.py,sha256=jAUAoQ_PMz76wyA1NXYHNKtOwoCnRT3My8_LCFrKi-U,13860
-reboost/hpge/surface.py,sha256=lbWcFnFFWKxtFKs755GyM9US_IfyxaoM6MpOIZgIMM0,7478
-reboost/hpge/utils.py,sha256=0Rx4HubCOm8JMECjWcAJXfAch9OkSlRpUkdsSlzwZ2E,2830
-reboost/math/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reboost/math/functions.py,sha256=OymiYTcA0NXxxm-MBDw5kqyNwHoLCmuv4J48AwnSrbU,5633
-reboost/math/stats.py,sha256=cG-6mQx33Dzpv3ABkHLEwC104WJ_PMgbWtmjg37SBj4,3164
-reboost/optmap/__init__.py,sha256=imvuyld-GLw8qdwqW-lXCg2feptcTyQo3wIzPvDHwmY,93
-reboost/optmap/cli.py,sha256=N8J2Hd8m_csYU9CtpAp7Rc3LHy6eNzZ26gWZgHCiUso,10250
-reboost/optmap/convolve.py,sha256=x7boLDcBJIsontoB0yemvzHSE2hlRpUomlDXc3jqdr4,14668
-reboost/optmap/create.py,sha256=_6GZbdRvmjDFs6DDbWC-THZxaNPUiLAOIDNaigMKJSQ,18139
-reboost/optmap/evt.py,sha256=UrjjNNeS7Uie4Ah9y_f5PyroFutLGo5aOFcwReOEy7o,5556
-reboost/optmap/mapview.py,sha256=73kpe0_SKDj9bIhEx1ybX1sBP8TyvufiLfps84A_ijA,6798
-reboost/optmap/numba_pdg.py,sha256=y8cXR5PWE2Liprp4ou7vl9do76dl84vXU52ZJD9_I7A,731
-reboost/optmap/optmap.py,sha256=j4rfbQ84PYSpE-BvP4Rdt96ZjPdwy8P4e4eZz1mATys,12817
-reboost/shape/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reboost/shape/cluster.py,sha256=RIvBlhHzp88aaUZGofp5SD9bimnoiqIOddhQ84jiwoM,8135
-reboost/shape/group.py,sha256=gOCYgir2gZqmW1JXtbNRPlQqP0gmUcbe7RVb9CbY1pU,5540
-reboost/shape/reduction.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reboost-0.6.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-reboost-0.6.1.dist-info/METADATA,sha256=T1TyULoQ01tNoZcuF1tfWdmG2WsV53DQuKCldpPEHRw,44222
-reboost-0.6.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-reboost-0.6.1.dist-info/entry_points.txt,sha256=DxhD6BidSWNot9BrejHJjQ7RRLmrMaBIl52T75oWTwM,93
-reboost-0.6.1.dist-info/top_level.txt,sha256=q-IBsDepaY_AbzbRmQoW8EZrITXRVawVnNrB-_zyXZs,8
-reboost-0.6.1.dist-info/RECORD,,