Changelog and improve description

catalystneuro · Jan 14, 2025 · 676dfdc · 676dfdc
1 parent fb03fbc
commit 676dfdc
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,8 +17,10 @@ Small fixes should be here.
 * Temporary set a ceiling for hdmf to avoid a chunking bug  [PR #1175](https://github.com/catalystneuro/neuroconv/pull/1175)
 
 ## Features
+* Add description to inter-sample-shift for `SpikeGLX` [PR #1177](https://github.com/catalystneuro/neuroconv/pull/1177)
 
 ## Improvements
+* Improve the naming of ElectrodeGroups in `SpikeGLX` when multi probes are present [PR #1177](https://github.com/catalystneuro/neuroconv/pull/1177)
 
 
 # v0.6.6 (December 20, 2024)

diff --git a/src/neuroconv/datainterfaces/ecephys/spikeglx/spikeglxdatainterface.py b/src/neuroconv/datainterfaces/ecephys/spikeglx/spikeglxdatainterface.py
@@ -147,7 +147,13 @@ def get_metadata(self) -> dict:
             dict(name="group_name", description="Name of the ElectrodeGroup this electrode is a part of."),
             dict(name="contact_shapes", description="The shape of the electrode"),
             dict(name="contact_ids", description="The id of the contact on the electrode"),
-            dict(name="inter_sample_shift", description="The inter-sample shift of the electrode"),
+            dict(
+                name="inter_sample_shift",
+                description=(
+                    "Array of relative phase shifts for each channel, with values ranging from 0 to 1, "
+                    "representing the fractional delay within the sampling period due to sequential ADC."
+                ),
+            ),
         ]
 
         if self.recording_extractor.get_probe().get_shank_count() > 1:

diff --git a/tests/test_on_data/ecephys/spikeglx_multi_probe_metadata.json b/tests/test_on_data/ecephys/spikeglx_multi_probe_metadata.json
@@ -48,7 +48,7 @@
       },
       {
         "name": "inter_sample_shift",
-        "description": "The inter-sample shift of the electrode"
+        "description": "Array of relative phase shifts for each channel, with values ranging from 0 to 1, representing the fractional delay within the sampling period due to sequential ADC."
       }
     ],
     "ElectricalSeriesAPImec1": {

diff --git a/tests/test_on_data/ecephys/spikeglx_single_probe_metadata.json b/tests/test_on_data/ecephys/spikeglx_single_probe_metadata.json
@@ -38,7 +38,7 @@
       },
       {
         "name": "inter_sample_shift",
-        "description": "The inter-sample shift of the electrode"
+        "description": "Array of relative phase shifts for each channel, with values ranging from 0 to 1, representing the fractional delay within the sampling period due to sequential ADC."
       }
     ],
     "ElectricalSeriesLF": {