simple proposal for buffer_id in rawio

Author: samuelgarcia

neo/rawio/baserawio.py

@@ -86,9 +86,15 @@
 
 error_header = "Header is not read yet, do parse_header() first"
 
+_signal_buffer_dtype = [
+    ("name", "U64"),  # not necessarily unique
+    ("id", "U64"),  # must be unique
+]
+
 _signal_stream_dtype = [
     ("name", "U64"),  # not necessarily unique
     ("id", "U64"),  # must be unique
+    ("buffer_id", "U64"),
 ]
 
 _signal_channel_dtype = [
@@ -100,6 +106,7 @@
     ("gain", "float64"),
     ("offset", "float64"),
     ("stream_id", "U64"),
+    ("buffer_id", "U64"),
 ]
 
 # TODO for later: add t_start and length in _signal_channel_dtype

neo/rawio/spikeglxrawio.py

@@ -60,6 +60,7 @@
     BaseRawIO,
     _signal_channel_dtype,
     _signal_stream_dtype,
+    _signal_buffer_dtype,
     _spike_channel_dtype,
     _event_channel_dtype,
 )
@@ -140,15 +141,20 @@ def _parse_header(self):
             self._memmaps[key] = data
 
         # create channel header
+        signal_buffers = []
         signal_streams = []
         signal_channels = []
         for stream_name in stream_names:
             # take first segment
             info = self.signals_info_dict[0, stream_name]
 
+            buffer_id = stream_name
+            buffer_name = stream_name
+            signal_buffers.append((buffer_name, buffer_id))
+
             stream_id = stream_name
             stream_index = stream_names.index(info["stream_name"])
-            signal_streams.append((stream_name, stream_id))
+            signal_streams.append((stream_name, stream_id, buffer_id))
 
             # add channels to global list
             for local_chan in range(info["num_chan"]):
@@ -164,6 +170,7 @@ def _parse_header(self):
                         info["channel_gains"][local_chan],
                         info["channel_offsets"][local_chan],
                         stream_id,
+                        buffer_id,
                     )
                 )
             # check sync channel validity
@@ -173,6 +180,7 @@ def _parse_header(self):
                 if self.load_sync_channel and not info["has_sync_trace"]:
                     raise ValueError("SYNC channel is not present in the recording. " "Set load_sync_channel to False")
 
+        signal_buffers = np.array(signal_buffers, dtype=_signal_buffer_dtype)
         signal_streams = np.array(signal_streams, dtype=_signal_stream_dtype)
         signal_channels = np.array(signal_channels, dtype=_signal_channel_dtype)
 
@@ -213,6 +221,7 @@ def _parse_header(self):
         self.header = {}
         self.header["nb_block"] = 1
         self.header["nb_segment"] = [nb_segment]
+        self.header["signal_buffers"] = signal_buffers
         self.header["signal_streams"] = signal_streams
         self.header["signal_channels"] = signal_channels
         self.header["spike_channels"] = spike_channels

neo/test/rawiotest/rawio_compliance.py

@@ -20,6 +20,7 @@
 from neo.rawio.baserawio import (
     _signal_channel_dtype,
     _signal_stream_dtype,
+    _signal_buffer_dtype,
     _spike_channel_dtype,
     _event_channel_dtype,
     _common_sig_characteristics,
@@ -47,6 +48,12 @@ def header_is_total(reader):
     assert "nb_segment" in h, "`nb_segment`missing in header"
     assert len(h["nb_segment"]) == h["nb_block"]
 
+    assert "signal_buffers" in h, "signal_buffers missing in header"
+    if h["signal_buffers"] is not None:
+        dt = h["signal_buffers"].dtype
+        for k, _ in _signal_buffer_dtype:
+            assert k in dt.fields, f"{k} not in _ignal_buffers.dtype"
+
     assert "signal_streams" in h, "signal_streams missing in header"
     if h["signal_streams"] is not None:
         dt = h["signal_streams"].dtype