Merge branch 'dev' into update/timeintervals

NeurodataWithoutBorders · Apr 26, 2022 · 265541e · 265541e
2 parents 5e9dd37 + 4cc938f
commit 265541e
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 6 deletions.
diff --git a/core/nwb.behavior.yaml b/core/nwb.behavior.yaml
@@ -16,11 +16,19 @@ groups:
     dims:
     - - num_times
     - - num_times
-      - num_features
+      - x
+    - - num_times
+      - x,y
+    - - num_times
+      - x,y,z
     shape:
     - - null
     - - null
-      - null
+      - 1
+    - - null
+      - 2
+    - - null
+      - 3
     doc: 1-D or 2-D array storing position or direction relative to some reference frame.
     attributes:
     - name: unit

diff --git a/core/nwb.file.yaml b/core/nwb.file.yaml
@@ -325,7 +325,8 @@ groups:
         - name: reference
           neurodata_type_inc: VectorData
           dtype: text
-          doc: Description of the reference used for this electrode.
+          doc: Description of the reference electrode and/or reference scheme used for this electrode, e.g.,
+            "stainless steel skull screw" or "online common average referencing".
           quantity: '?'
     - name: intracellular_ephys
       doc: Metadata related to intracellular electrophysiology.

diff --git a/core/nwb.icephys.yaml b/core/nwb.icephys.yaml
@@ -199,6 +199,10 @@ groups:
   neurodata_type_inc: NWBContainer
   doc: An intracellular electrode and its metadata.
   datasets:
+  - name: cell_id
+    dtype: text
+    doc: unique ID of the cell
+    quantity: '?'
   - name: description
     dtype: text
     doc: Description of electrode (e.g.,  whole-cell, sharp, etc.).

diff --git a/core/nwb.ophys.yaml b/core/nwb.ophys.yaml
@@ -217,7 +217,7 @@ groups:
       default_value: 1.0
       doc: Scalar to multiply each element in data to convert it to the specified 'unit'.
         If the data are stored in acquisition system units or other units
-        that require a conversion to be interpretable, multiply the data by 'conversion' and add 'offset'
+        that require a conversion to be interpretable, multiply the data by 'conversion'
         to convert the data to the specified 'unit'. e.g. if the data acquisition system
         stores values in this object as pixels from x = -500 to 499, y = -500 to 499
         that correspond to a 2 m x 2 m range, then the 'conversion' multiplier to get

diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst
@@ -6,6 +6,10 @@ Release Notes
 2.5.0 (Upcoming)
 ---------------------
 
+Major changes
+^^^^^^^^^^^^^
+- Shape of SpatialSeries.data is more restrictive to prevent > 3 columns. (#510)
+
 Minor changes
 ^^^^^^^^^^^^^
 - Added an ``offset`` attribute to all ``TimeSeries`` objects to allow enhanced translation to scientific units.
@@ -14,8 +18,9 @@ Minor changes
   from ``VectorData`` to ```TimeSeriesReferenceVectorData``. This change replaces the existing ``TimeIntervals.timeseries``
   column with a ``TimeSeriesReferenceVectorData`` type column of the same name and overall schema. This change facilitates creating
   common functionality around ``TimeSeriesReferenceVectorData``. This change affects all existing ``TimeIntervals`` tables
-  as part of the ``intervals/`` group, i.e., ``intervals/epochs``, ``intervals/trials``, and ``intervals/invalid_times`` (#486)
-
+  as part of the ``intervals/`` group, i.e., ``intervals/epochs``, ``intervals/trials``, and ``intervals/invalid_times``. (#486)
+- Clarified the doc string for the ``reference`` column of the electrodes table. (#498)
+- Added ``cell_id`` field to ``IntracellularElectrode``. (#512)
 
 2.4.0 (Aug. 11, 2021)
 ---------------------