minor cleanup xdf

Author: patricefortin

data/XDF/dyad-example-with-markers.xdf

@@ -14,7 +14,7 @@ class Markers():
 
     Parameters:
         timestamps (1D np.array): The time of markers
-        descriptions (List[str]): The string valu for every marker. Must have the same length as timestamps
+        descriptions (List[str]): The string value for every marker. Must have the same length as timestamps
     """
     timestamps: np.array
     descriptions: List[str]

hypyp/xdf/xdf_stream.py

@@ -4,29 +4,26 @@
 from hypyp.xdf import XDFImport, XDFStream
 import mne
 
-#file_path = 'data/dyad-example.xdf'
-#file_path = 'data/ExampleWorkshopData/FingerTappingExample4.xdf'
-
 file_path = 'data/XDF/dyad-example-noise.xdf'
 file_path_with_markers = 'data/XDF/dyad-example-with-markers.xdf'
 
-# These have been extracted with print(xdf)
-#Stream id 3 of type 'Markers' with name 'LSLOutletHS1-Markers'
-#Stream id 1 of type 'Accelerometer' with name 'LSLOutletHS1-Accelerometer'
-#Stream id 8 of type 'Quality' with name 'LSLOutletHS1-Quality'
-#Stream id 2 of type 'EEG' with name 'LSLOutletHS1-EEG'
-#Stream id 4 of type 'Markers' with name 'LSLOutletHS2-Markers'
-#Stream id 6 of type 'Accelerometer' with name 'LSLOutletHS2-Accelerometer'
-#Stream id 5 of type 'Quality' with name 'LSLOutletHS2-Quality'
-#Stream id 7 of type 'EEG' with name 'LSLOutletHS2-EEG'
-STREAM_ID_MARKERS_1 = 3
+## These have been extracted with print(xdf), and are used for testing select_match by stream id and mapping
+#   Stream id 1 of type 'Accelerometer' with name 'LSLOutletHS1-Accelerometer'
+#   Stream id 2 of type 'EEG' with name 'LSLOutletHS1-EEG'
+#   Stream id 3 of type 'Markers' with name 'LSLOutletHS1-Markers'
+#   Stream id 4 of type 'Markers' with name 'LSLOutletHS2-Markers'
+#   Stream id 5 of type 'Quality' with name 'LSLOutletHS2-Quality'
+#   Stream id 6 of type 'Accelerometer' with name 'LSLOutletHS2-Accelerometer'
+#   Stream id 7 of type 'EEG' with name 'LSLOutletHS2-EEG'
+#   Stream id 8 of type 'Quality' with name 'LSLOutletHS1-Quality'
 STREAM_ID_ACC_1 = 1
-STREAM_ID_QUALITY_1 = 8
 STREAM_ID_EEG_1 = 2
+STREAM_ID_MARKERS_1 = 3
 STREAM_ID_MARKERS_2 = 4
-STREAM_ID_ACC_2 = 6
 STREAM_ID_QUALITY_2 = 5
+STREAM_ID_ACC_2 = 6
 STREAM_ID_EEG_2 = 7
+STREAM_ID_QUALITY_1 = 8
 
 def test_instanciate():
     xdf = XDFImport(file_path)
@@ -42,7 +39,6 @@ def test_instanciate():
     assert xdf.available_streams[6].name == 'LSLOutletHS2-Quality'
     assert xdf.available_streams[7].name == 'LSLOutletHS2-EEG'
 
-
     assert xdf.available_streams[0].type == 'Markers'
     assert xdf.available_streams[1].type == 'Accelerometer'
     assert xdf.available_streams[2].type == 'Quality'
@@ -186,7 +182,6 @@ def test_subject_unique_name():
     assert xdf.selected_streams[0].get_unique_name() == 'LSLOutletHS1-Accelerometer'
     assert xdf.selected_streams[0].get_unique_name(append_stream_id=True) == 'LSLOutletHS1-Accelerometer-1'
 
-    
 def test_markers():
     xdf = XDFImport(file_path_with_markers)
     keys = list(xdf.markers_dict)

poetry.lock

@@ -8,9 +8,9 @@
     "# Importing XDF files in HyPyP\n",
     "@Author : [@jonasmago](https://github.com/jonasmago) & [@FranckPrts](https://github.com/FranckPrts).\n",
     "\n",
-    "Updated by : Patrice Fortin\n",
+    "Updated by : [@patricefortin](https://github.com/patricefortin) \n",
     "\n",
-    "Last updated: \n",
+    "Last updated: 2025/6/6\n",
     "\n",
     "This tutorial guides you in using the `XDFImport` class provided by [HyPyP](https://github.com/ppsp-team/HyPyP/blob/master/hypyp/xdf/).\n",
     "\n",
@@ -28,13 +28,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
     "from hypyp.xdf import XDFImport\n",
     "\n",
+    "# This file has been generated using 2 starstim-32 and recorded by LabRecorder.\n",
+    "# No participant were wearing the starstim so we only have noise\n",
     "path_xdf = \"../data/XDF/dyad-example-noise.xdf\"\n",
+    "\n",
+    "# This file has been generated from synthetic noise\n",
     "path_xdf_with_markers = \"../data/XDF/dyad-example-with-markers.xdf\""
    ]
   },
@@ -171,6 +175,20 @@
    "execution_count": 4,
    "metadata": {},
    "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Error reading chunk length\n",
+      "Traceback (most recent call last):\n",
+      "  File \"/home/patrice/.cache/pypoetry/virtualenvs/hypyp-9w4TS9uv-py3.12/lib/python3.12/site-packages/pyxdf/pyxdf.py\", line 230, in load_xdf\n",
+      "    chunklen = _read_varlen_int(f)\n",
+      "               ^^^^^^^^^^^^^^^^^^^\n",
+      "  File \"/home/patrice/.cache/pypoetry/virtualenvs/hypyp-9w4TS9uv-py3.12/lib/python3.12/site-packages/pyxdf/pyxdf.py\", line 489, in _read_varlen_int\n",
+      "    raise RuntimeError(\"invalid variable-length integer encountered.\")\n",
+      "RuntimeError: invalid variable-length integer encountered.\n"
+     ]
+    },
     {
      "name": "stdout",
      "output_type": "stream",
@@ -189,11 +207,11 @@
       "    Channel types: [stim]\n",
       "  Stream id 3 of type 'EEG' with name 'EEG_subject_1'\n",
       "    Sampling Rate: 1000.0\n",
-      "    Channel names: [foo,bar,baz]\n",
+      "    Channel names: [Ch1,Ch2,Ch3]\n",
       "    Channel types: [eeg,eeg,eeg]\n",
       "  Stream id 1 of type 'EEG' with name 'EEG_subject_2'\n",
       "    Sampling Rate: 1000.0\n",
-      "    Channel names: [foo,bar,baz]\n",
+      "    Channel names: [Ch1,Ch2,Ch3]\n",
       "    Channel types: [eeg,eeg,eeg]\n",
       "Selected streams: [RandomStrStream,EEG_subject_1,EEG_subject_2]\n",
       "\n",
@@ -538,13 +556,13 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Writing /tmp/tmpnbmrtr9u/LSLOutletHS1-EEG_raw.fif\n",
-      "Closing /tmp/tmpnbmrtr9u/LSLOutletHS1-EEG_raw.fif\n",
+      "Writing /tmp/tmp0k1yas12/LSLOutletHS1-EEG_raw.fif\n",
+      "Closing /tmp/tmp0k1yas12/LSLOutletHS1-EEG_raw.fif\n",
       "[done]\n",
-      "Writing /tmp/tmpnbmrtr9u/LSLOutletHS2-EEG_raw.fif\n",
-      "Closing /tmp/tmpnbmrtr9u/LSLOutletHS2-EEG_raw.fif\n",
+      "Writing /tmp/tmp0k1yas12/LSLOutletHS2-EEG_raw.fif\n",
+      "Closing /tmp/tmp0k1yas12/LSLOutletHS2-EEG_raw.fif\n",
       "[done]\n",
-      "Files: ['/tmp/tmpnbmrtr9u/LSLOutletHS1-EEG_raw.fif', '/tmp/tmpnbmrtr9u/LSLOutletHS2-EEG_raw.fif']\n"
+      "Files: ['/tmp/tmp0k1yas12/LSLOutletHS1-EEG_raw.fif', '/tmp/tmp0k1yas12/LSLOutletHS2-EEG_raw.fif']\n"
      ]
     }
    ],
@@ -624,7 +642,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": 17,
    "metadata": {},
    "outputs": [
     {
@@ -730,15 +748,6 @@
     "\n",
     "xdf_misc.mne_raws[0].plot(duration=1, start=14)"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "\n"
-   ]
   }
  ],
  "metadata": {