Make ImageSeries/data required

NeurodataWithoutBorders · Aug 5, 2021 · 477f921 · 477f921
1 parent 345d022
commit 477f921
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/core/nwb.image.yaml b/core/nwb.image.yaml
@@ -63,8 +63,8 @@ groups:
       - null
       - null
       - null
-    doc: Binary data representing images across frames.
-    quantity: '?'
+    doc: Binary data representing images across frames. If data are stored in an external
+      file, this should be an empty 3D array.
   - name: dimension
     dtype: int32
     dims:

diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst
@@ -7,6 +7,10 @@ Release Notes
 - Fix incorrect dtype for electrodes table column "filtering" (float -> text)
 - Remove "quantity: *" from the type definitions of ``OptogeneticStimulusSite`` and ``ImagingPlane``.
   This change improves clarity of the schema to follow best practices. It has no functional effect on the schema.
+- Require the "data" dataset in ``ImageSeries``. Since ``ImageSeries`` is a ``TimeSeries`` and ``TimeSeries`` requires
+  the "data" dataset, ``ImageSeries`` should also require the "data" dataset. Otherwise this creates problems for
+  inheritance and validation. If ``ImageSeries`` data are stored in an external file, then "data" should be set to
+  an empty 3D array.
 
 2.3.0 (May 12, 2021)
 ---------------------