Merge pull request #1008 from NeurodataWithoutBorders/waveform_dims

change dims for Units waveform

Author: bendichter

src/pynwb/data/nwb.misc.yaml

@@ -253,21 +253,33 @@ groups:
     neurodata_type_inc: VectorData
     dtype: float
     dims:
-    - num_units
-    - num_samples
+    - - num_units
+      - num_samples
+    - - num_units
+      - num_samples
+      - num_electrodes
     shape:
-    - null
-    - null
+    - - null
+      - null
+    - - null
+      - null
+      - null
     doc: the spike waveform mean for each spike unit
     quantity: '?'
   - name: waveform_sd
     neurodata_type_inc: VectorData
     dtype: float
     dims:
-    - num_units
-    - num_samples
+    - - num_units
+      - num_samples
+    - - num_units
+      - num_samples
+      - num_electrodes
     shape:
-    - null
-    - null
+    - - null
+      - null
+    - - null
+      - null
+      - null
     doc: the spike waveform standard deviation for each spike unit
     quantity: '?'

src/pynwb/misc.py

@@ -218,10 +218,11 @@ def __init__(self, **kwargs):
              'default': None},
             {'name': 'electrode_group', 'type': 'ElectrodeGroup', 'default': None,
              'doc': 'the electrode group that each unit came from'},
-            {'name': 'waveform_mean', 'type': 'array_data', 'doc': 'the spike waveform mean for each unit',
+            {'name': 'waveform_mean', 'type': 'array_data',
+             'doc': 'the spike waveform mean for each unit. Shape is (time,) or (time, electrodes)',
              'default': None},
             {'name': 'waveform_sd', 'type': 'array_data', 'default': None,
-             'doc': 'the spike waveform standard deviation for each unit'},
+             'doc': 'the spike waveform standard deviation for each unit. Shape is (time,) or (time, electrodes)'},
             {'name': 'id', 'type': int, 'default': None,
              'help': 'the id for each unit'},
             allow_extra=True)