legend-daq2lh5 1.1.0__py3-none-any.whl → 1.2.0a1__py3-none-any.whl

daq2lh5/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.1.0'
-__version_tuple__ = version_tuple = (1, 1, 0)
+__version__ = version = '1.2.0a1'
+__version_tuple__ = version_tuple = (1, 2, 0)

daq2lh5/buffer_processor/buffer_processor.py

@@ -51,14 +51,14 @@ def buffer_processor(rb: RawBuffer) -> Table:
     ``"compression": {"lgdo": "codec_name" [, ...]}`` `(dict)`
       Updates the `compression` attribute of `lgdo` to `codec_name`. The
       attribute sets the compression algorithm applied by
-      :func:`~.lgdo.lh5_store.LH5Store.read_object` before writing `lgdo` to
+      :func:`~lgdo.lh5.store.LH5Store.read` before writing `lgdo` to
       disk. Can be used to apply custom waveform compression algorithms from
       :mod:`lgdo.compression`.
 
     ``"hdf5_settings": {"lgdo": { <HDF5 settings> }}`` `(dict)`
       Updates the `hdf5_settings` attribute of `lgdo`. The attribute sets the
       HDF5 dataset options applied by
-      :func:`~.lgdo.lh5_store.LH5Store.read_object` before writing `lgdo` to
+      :func:`~lgdo.lh5.store.LH5Store.read` before writing `lgdo` to
       disk.
 
     Parameters
@@ -295,7 +295,7 @@ def process_windowed_t0(t0s: Array, dts: Array, start_index: int) -> Array:
 
 
 def process_dsp(rb: RawBuffer, tmp_table: Table) -> None:
-    r"""Run a DSP processing chain.
+    r"""Run a DSP processing chain with :mod:`dspeed`.
 
     Run a provided DSP config from `rb.proc_spec` using
     :func:`.dsp.build_processing_chain`, and add specified outputs to the

daq2lh5/buffer_processor/lh5_buffer_processor.py

@@ -6,7 +6,7 @@ import os
 
 import h5py
 import lgdo
-from lgdo import LH5Store
+from lgdo import lh5
 
 from ..buffer_processor.buffer_processor import buffer_processor
 from ..raw_buffer import RawBuffer, RawBufferLibrary
@@ -54,14 +54,14 @@ def lh5_buffer_processor(
     """
 
     # Initialize the input raw file
-    raw_store = LH5Store()
+    raw_store = lh5.LH5Store()
     lh5_file = raw_store.gimme_file(lh5_raw_file_in, "r")
     if lh5_file is None:
         raise ValueError(f"input file not found: {lh5_raw_file_in}")
         return
 
     # List the groups in the raw file
-    lh5_groups = lgdo.ls(lh5_raw_file_in)
+    lh5_groups = lh5.ls(lh5_raw_file_in)
     lh5_tables = []
 
     # check if group points to raw data; sometimes 'raw' is nested, e.g g024/raw
@@ -69,21 +69,19 @@ def lh5_buffer_processor(
         # Make sure that the upper level key isn't a dataset
         if isinstance(lh5_file[tb], h5py.Dataset):
             lh5_tables.append(f"{tb}")
-        elif "raw" not in tb and lgdo.ls(lh5_file, f"{tb}/raw"):
+        elif "raw" not in tb and lh5.ls(lh5_file, f"{tb}/raw"):
             lh5_tables.append(f"{tb}/raw")
         # Look one layer deeper for a :meth:`lgdo.Table` if necessary
-        elif lgdo.ls(lh5_file, f"{tb}"):
+        elif lh5.ls(lh5_file, f"{tb}"):
             # Check to make sure that this isn't a table itself
-            maybe_table, _ = raw_store.read_object(f"{tb}", lh5_file)
+            maybe_table, _ = raw_store.read(f"{tb}", lh5_file)
             if isinstance(maybe_table, lgdo.Table):
                 lh5_tables.append(f"{tb}")
                 del maybe_table
             # otherwise, go deeper
             else:
-                for sub_table in lgdo.ls(lh5_file, f"{tb}"):
-                    maybe_table, _ = raw_store.read_object(
-                        f"{tb}/{sub_table}", lh5_file
-                    )
+                for sub_table in lh5.ls(lh5_file, f"{tb}"):
+                    maybe_table, _ = raw_store.read(f"{tb}/{sub_table}", lh5_file)
                     if isinstance(maybe_table, lgdo.Table):
                         lh5_tables.append(f"{tb}/{sub_table}")
                     del maybe_table
@@ -114,7 +112,7 @@ def lh5_buffer_processor(
 
     # Write everything in the raw file to the new file, check for proc_spec under either the group name, out_name, or the name
     for tb in lh5_tables:
-        lgdo_obj, _ = raw_store.read_object(f"{tb}", lh5_file)
+        lgdo_obj, _ = raw_store.read(f"{tb}", lh5_file)
 
         # Find the out_name.
         # If the top level group has an lgdo table in it, then the out_name is group
@@ -198,6 +196,4 @@ def lh5_buffer_processor(
                 pass
 
         # Write the (possibly processed) lgdo_obj to a file
-        raw_store.write_object(
-            lgdo_obj, out_name, lh5_file=proc_file_name, group=group_name
-        )
+        raw_store.write(lgdo_obj, out_name, lh5_file=proc_file_name, group=group_name)

daq2lh5/build_raw.py

@@ -6,8 +6,8 @@ import logging
 import os
 import time
 
-import lgdo
 import numpy as np
+from lgdo import lh5
 from tqdm.auto import tqdm
 
 from .compass.compass_streamer import CompassStreamer
@@ -77,7 +77,7 @@ def build_raw(
 
     hdf5_settings
         keyword arguments (as a dict) forwarded to
-        :meth:`~.lgdo.lh5_store.LH5Store.write_object`.
+        :meth:`lgdo.lh5.store.LH5Store.write`.
 
     **kwargs
         sent to :class:`.RawBufferLibrary` generation as `kw_dict` argument.
@@ -224,7 +224,7 @@ def build_raw(
         os.remove(out_file_glob[0])
 
     # Write header data
-    lh5_store = lgdo.LH5Store(keep_open=True)
+    lh5_store = lh5.LH5Store(keep_open=True)
     write_to_lh5_and_clear(header_data, lh5_store, **hdf5_settings)
 
     # Now loop through the data

daq2lh5/data_decoder.py

@@ -3,13 +3,10 @@ Base classes for decoding data into raw LGDO Tables or files
 """
 from __future__ import annotations
 
-from typing import Union
-
 import lgdo
 import numpy as np
-from lgdo import LH5Store
-
-LGDO = Union[lgdo.Scalar, lgdo.Struct, lgdo.Array, lgdo.VectorOfVectors]
+from lgdo import LGDO
+from lgdo.lh5 import LH5Store
 
 
 class DataDecoder:
@@ -18,15 +15,16 @@ class DataDecoder:
     Most decoders will repeatedly decode the same set of values from each
     packet.  The values that get decoded need to be described by a dict stored
     in `self.decoded_values` that helps determine how to set up the buffers and
-    write them to file as :class:`~.lgdo.LGDO`\ s. :class:`~.lgdo.table.Table`\ s
-    are made whose columns correspond to the elements of `decoded_values`, and
-    packet data gets pushed to the end of the table one row at a time.
+    write them to file as :class:`~lgdo.types.lgdo.LGDO`\ s.
+    :class:`~lgdo.types.table.Table`\ s are made whose columns correspond to
+    the elements of `decoded_values`, and packet data gets pushed to the end of
+    the table one row at a time.
 
     Any key-value entry in a configuration dictionary attached to an element
     of `decoded_values` is typically interpreted as an attribute to be attached
     to the corresponding LGDO. This feature can be for example exploited to
     specify HDF5 dataset settings used by
-    :meth:`~.lgdo.lh5_store.LH5Store.write_object` to write LGDOs to disk.
+    :meth:`~lgdo.lh5.store.LH5Store.write` to write LGDOs to disk.
 
     For example ::
 
@@ -49,7 +47,7 @@ class DataDecoder:
     will have its `compression` attribute set to
     ``RadwareSigcompress(codec_shift=-32768)``.  Before being written to disk,
     they will be compressed with the HDF5 built-in Gzip filter and with the
-    :class:`~.lgdo.compression.radware.RadwareSigcompress` waveform compressor.
+    :class:`~lgdo.compression.radware.RadwareSigcompress` waveform compressor.
 
     Examples
     --------
@@ -119,7 +117,7 @@ class DataDecoder:
         """Make an LGDO for this :class:`DataDecoder` to fill.
 
         This default version of this function allocates a
-        :class:`~.lgdo.table.Table` using the `decoded_values` for key. If a
+        :class:`~lgdo.types.table.Table` using the `decoded_values` for key. If a
         different type of LGDO object is required for this decoder, overload
         this function.
 
@@ -207,7 +205,7 @@ class DataDecoder:
                 continue
 
             # Parse datatype for remaining lgdos
-            datatype, shape, elements = lgdo.lgdo_utils.parse_datatype(datatype)
+            datatype, shape, elements = lgdo.lh5.utils.parse_datatype(datatype)
 
             # ArrayOfEqualSizedArrays
             if datatype == "array_of_equalsized_arrays":
@@ -258,7 +256,7 @@ class DataDecoder:
         n_rows = self.garbage_table.loc
         if n_rows == 0:
             return
-        lh5_store.write_object(
+        lh5_store.write(
             self.garbage_table, "garbage", filename, group, n_rows=n_rows, append=True
         )
         self.garbage_table.clear()

daq2lh5/fc/fc_config_decoder.py

@@ -28,7 +28,7 @@ class FCConfigDecoder(DataDecoder):
     >>> decoder = FCConfigDecoder()
     >>> config = decoder.decode_config(fc)
     >>> type(config)
-    lgdo.struct.Struct
+    lgdo.types.struct.Struct
     """
 
     def __init__(self, *args, **kwargs) -> None:

daq2lh5/orca/orca_digitizers.py

@@ -98,11 +98,11 @@ class ORSIS3302DecoderForEnergy(OrcaDecoder):
                         sys.exit()
                     self.decoded_values[ccc]["waveform"]["wf_len"] = trace_length
 
-    def get_key_lists(self) -> list[list[str]]:
+    def get_key_lists(self) -> list[list[int]]:
         key_lists = []
         for key in self.decoded_values.keys():
             key_lists.append([key])
-        return [key_lists]
+        return key_lists
 
     def get_decoded_values(self, key: int = None) -> dict[str, Any]:
         if key is None:

daq2lh5/raw_buffer.py

@@ -65,21 +65,19 @@ keys.
 from __future__ import annotations
 
 import os
-from typing import Union
 
 import lgdo
-from lgdo import LH5Store
+from lgdo import LGDO
+from lgdo.lh5 import LH5Store
 
 from .buffer_processor.buffer_processor import buffer_processor
 
-LGDO = Union[lgdo.Scalar, lgdo.Struct, lgdo.Array, lgdo.VectorOfVectors]
-
 
 class RawBuffer:
     r"""Base class to represent a buffer of raw data.
 
     A :class:`RawBuffer` is in essence a an LGDO object (typically a
-    :class:`~.lgdo.table.Table`) to which decoded data will be written, along
+    :class:`~lgdo.types.table.Table`) to which decoded data will be written, along
     with some meta-data distinguishing what data goes into it, and where the
     LGDO gets written out. Also holds on to the current location in the buffer
     for writing.
@@ -88,7 +86,7 @@ class RawBuffer:
     ----------
     lgdo
         the LGDO used as the actual buffer. Typically a
-        :class:`~.lgdo.table.Table`. Set to ``None`` upon creation so that the
+        :class:`~lgdo.types.table.Table`. Set to ``None`` upon creation so that the
         user or a decoder can initialize it later.
     key_list
         a list of keys (e.g. channel numbers) identifying data to be written
@@ -107,7 +105,7 @@ class RawBuffer:
     proc_spec
         a dictionary containing the following:
         - a DSP config file, passed as a dictionary, or as a path to a JSON file
-        - an array containing: the name of an :class:`~.lgdo` object stored in the :class:`.RawBuffer` to be sliced,
+        - an array containing: the name of an LGDO object stored in the :class:`.RawBuffer` to be sliced,
         the start and end indices of the slice, and the new name for the sliced object
         - a dictionary of fields to drop
         - a dictionary of new fields and their return datatype
@@ -440,11 +438,11 @@ def write_to_lh5_and_clear(
         files (saves some time opening / closing files).
     **kwargs
         keyword-arguments forwarded to
-        :meth:`.lgdo.lh5_store.LH5Store.write_object`.
+        :meth:`lgdo.lh5.store.LH5Store.write`.
 
     See Also
     --------
-    .lgdo.lh5_store.LH5Store.write_object
+    lgdo.lh5.store.LH5Store.write
     """
     if lh5_store is None:
         lh5_store = lgdo.LH5Store()
@@ -470,7 +468,7 @@ def write_to_lh5_and_clear(
 
         # write if requested...
         if filename != "":
-            lh5_store.write_object(
+            lh5_store.write(
                 lgdo_to_write,
                 rb.out_name,
                 filename,

{legend_daq2lh5-1.1.0.dist-info → legend_daq2lh5-1.2.0a1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: legend-daq2lh5
-Version: 1.1.0
+Name: legend_daq2lh5
+Version: 1.2.0a1
 Summary: Convert digitizer data to LH5
 Home-page: https://github.com/legend-exp/legend-daq2lh5
 Author: Jason Detwiler
@@ -26,10 +26,10 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: dspeed >=1.1
+Requires-Dist: dspeed >=1.3.0a4
 Requires-Dist: h5py >=3.2.0
 Requires-Dist: hdf5plugin
-Requires-Dist: legend-pydataobj >=1.4.1
+Requires-Dist: legend-pydataobj >=1.5.0a1
 Requires-Dist: numpy >=1.21
 Requires-Dist: pyfcutils
 Requires-Dist: tqdm >=4.27

{legend_daq2lh5-1.1.0.dist-info → legend_daq2lh5-1.2.0a1.dist-info}/RECORD

@@ -1,36 +1,36 @@
 daq2lh5/__init__.py,sha256=VPmwKuZSA0icpce05ojhnsKWhR4_QUgD0oVXUoN9wks,975
-daq2lh5/_version.py,sha256=CqDGE4B1ZqZ-56mxeOFcXRTmlxrdOh4ayrjbcPjziE4,411
-daq2lh5/build_raw.py,sha256=cheTM1H0NUTJ4TprGMLWMHnXsVRJk_EhWak7xwaH5P0,10525
+daq2lh5/_version.py,sha256=k5PS9p0a5Ey36DDxagN4mnTZow7bHSa0Oh_ycx0FrX4,413
+daq2lh5/build_raw.py,sha256=JFXC5ln9u353TUZMksY3zydLiV2HlxqdI6_Y2_ZMCIE,10524
 daq2lh5/cli.py,sha256=HCZ9Vyg-gqvairN9zJIpBjw5vLpp9ZUOOQYLFxloLL8,2912
-daq2lh5/data_decoder.py,sha256=40cRLJH25BgCj9Z-EDCD5A2XrKZRWnSDALNkr35QI3U,10708
+daq2lh5/data_decoder.py,sha256=ka2WIJuPvsG892__HCW1SagCEzyiZJ2kQP6zGDMtlr0,10641
 daq2lh5/data_streamer.py,sha256=6SEAekOHyfC4k3E0df0lW37ap6ZemVFbH8PYMl6UvCU,14130
 daq2lh5/logging.py,sha256=Nu3wgIoWN7cyUxuzPom5rMwFvTlBu8p8d9uONHDquRg,965
-daq2lh5/raw_buffer.py,sha256=yVLUYhxLe6KOjwxq_k91MAekx3ZUYmWL32GAhu3ahls,17784
+daq2lh5/raw_buffer.py,sha256=dyPUok0N3MP41oP9F8sO_PrH7-SWs9UdPh7dqCF729g,17687
 daq2lh5/buffer_processor/__init__.py,sha256=7k6v_KPximtv7805QnX4-xp_S3vqvqwDfdV3q95oZJo,84
-daq2lh5/buffer_processor/buffer_processor.py,sha256=dUgG1PRoxZgTX5XmxBKyEDnIx7Met_l02kLimsphjq8,14480
-daq2lh5/buffer_processor/lh5_buffer_processor.py,sha256=Jf-lVM6t9Ui-6-0fr9tXkMsX6ButHZB7I0gyJcRQqw8,8323
+daq2lh5/buffer_processor/buffer_processor.py,sha256=GUxpNDbqGLuUEZmXjeratipbzmki12RFNYZkxgMtesg,14483
+daq2lh5/buffer_processor/lh5_buffer_processor.py,sha256=yL1ru0_GTsZx099oi45sXL-FxPfdChtStd_IFtZNI_Q,8222
 daq2lh5/compass/__init__.py,sha256=mOXHWp7kRDgNTPQty3E8k2KPSy_vAzjneKfAcCVaPyE,132
 daq2lh5/compass/compass_config_parser.py,sha256=zeAsOo1dOJPGLL8-zkAcdYRkqt8BodtOPi96n7fWsl4,12300
 daq2lh5/compass/compass_event_decoder.py,sha256=kiPOaEu8SgLD2wbSPbBahcbTBBRAIw35wtVLBcwPcXY,7386
 daq2lh5/compass/compass_header_decoder.py,sha256=AA-Md2FIT3nD4mXX9CrWvbbfmKiA436-BTmzcU3_XOY,2823
 daq2lh5/compass/compass_streamer.py,sha256=zSl7IqO0ID0wcixkLE9QVEG3bF9hfGVITVPomCeOFTM,8841
 daq2lh5/fc/__init__.py,sha256=bB1j6r-bDmylNi0iutQeAJGjsDSjLSoXMqFfXWwfb8I,141
-daq2lh5/fc/fc_config_decoder.py,sha256=6PA4AGxfoI9S22lfoMFgb4L_tMloT1TF7HWi2r7OJaM,1990
+daq2lh5/fc/fc_config_decoder.py,sha256=RLRfUOZN0vYbAprqTymP7TGg641IiP9rgCGIOwWVKzU,1996
 daq2lh5/fc/fc_event_decoder.py,sha256=JIRsySnxeuY3wmxjJOrTXo6wpelVup8WIvxU-fkPL-A,8131
 daq2lh5/fc/fc_status_decoder.py,sha256=o_3vTAgYXelZxIsreCYioVYid2mY-wqloYKlxoCqX5Q,3390
 daq2lh5/fc/fc_streamer.py,sha256=S0imXdVsiyolPvxI1uiBngpC58DporSNZPqx1HeVi5o,5737
 daq2lh5/orca/__init__.py,sha256=Xf6uOIOzk_QkKH_7VizGlCo3iuiAgLtUE3A07x_HXC0,175
 daq2lh5/orca/orca_base.py,sha256=-XIolXsHj-1EdewaGxyvJTZvRGZsDyZe-5PzVOd-LFY,1333
-daq2lh5/orca/orca_digitizers.py,sha256=rpk2SSDQgE681FB_iaewAuTXCVEqhUTlhLAm0RGJDfo,20869
+daq2lh5/orca/orca_digitizers.py,sha256=BsAA3OgQ13YIirDM8pd_xDY3F5FqEY4YjSHviflmov8,20867
 daq2lh5/orca/orca_flashcam.py,sha256=gsvPorUXk1Jn-U93GsxXJ5z6pbTK2yjsYDqZFVCm57U,33088
 daq2lh5/orca/orca_header.py,sha256=1tDRG8l9Gqu4c0K4BjXBSC5eiLTzY_HaCsgNBiv5EgI,4283
 daq2lh5/orca/orca_header_decoder.py,sha256=ORIIyfx22ybyKc-uyWy5ER49-dl3BGpHdfV8OCDmjIw,1632
 daq2lh5/orca/orca_packet.py,sha256=TcdfuYN8_gcug_Xdjz98KqjHw1MqJ4J98zc7WI2xtf4,2488
 daq2lh5/orca/orca_run_decoder.py,sha256=3atKXC6mDi8_PK6ICUBBJ-LyaTM8OU31kKWIpmttRr4,2065
 daq2lh5/orca/orca_streamer.py,sha256=VbD9PF-rx_Rk-rEy7XECPmgxr6kZSUf0tC7Qbol3Qeg,15693
-legend_daq2lh5-1.1.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-legend_daq2lh5-1.1.0.dist-info/METADATA,sha256=-hWP-SmhkRHTo2nRZs1Hxi4bQ3Ao2lymLKz_Dz4av_Y,3747
-legend_daq2lh5-1.1.0.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-legend_daq2lh5-1.1.0.dist-info/entry_points.txt,sha256=R08R4NrHi0ab5MJN_qKqzePVzrLSsw5WpmbiwwduYjw,59
-legend_daq2lh5-1.1.0.dist-info/top_level.txt,sha256=MJQVLyLqMgMKBdVfNXFaCKCjHKakAs19VLbC9ctXZ7A,8
-legend_daq2lh5-1.1.0.dist-info/RECORD,,
+legend_daq2lh5-1.2.0a1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+legend_daq2lh5-1.2.0a1.dist-info/METADATA,sha256=QiBKAO0ycatdNK5W8HlhHXA28pUnqFr2iPnjyjr2RAE,3755
+legend_daq2lh5-1.2.0a1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+legend_daq2lh5-1.2.0a1.dist-info/entry_points.txt,sha256=R08R4NrHi0ab5MJN_qKqzePVzrLSsw5WpmbiwwduYjw,59
+legend_daq2lh5-1.2.0a1.dist-info/top_level.txt,sha256=MJQVLyLqMgMKBdVfNXFaCKCjHKakAs19VLbC9ctXZ7A,8
+legend_daq2lh5-1.2.0a1.dist-info/RECORD,,

{legend_daq2lh5-1.1.0.dist-info → legend_daq2lh5-1.2.0a1.dist-info}/WHEEL

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