@@ -38,8 +38,9 @@ groups:
3838 neurodata_type_inc : TimeSeries
3939 doc : General image data that is common between acquisition and stimulus time series.
4040 Sometimes the image data is stored in the file in a raw format while other
41- times it will be stored as an external image file in the host file system. The
42- data field will either be binary data or empty. [frame][y][x] or [frame][z][y][x].
41+ times it will be stored as a series of external image files in the host file system.
42+ The data field will either be binary data, if the data is stored in the NWB file, or
43+ empty, if the data is stored in an external image stack. [frame][y][x] or [frame][z][y][x].
4344 datasets :
4445 - name : data
4546 dtype : numeric
@@ -75,8 +76,8 @@ groups:
7576 - num_files
7677 shape :
7778 - null
78- doc : Paths or URLs to one or more external file(s). Field only present if format=external.
79- This is only relevant if the image is stored in the file system as one
79+ doc : Paths to one or more external file(s). The field is only present if format=' external' .
80+ This is only relevant if the image series is stored in the file system as one
8081 or more image file(s). This field should NOT be used if the image is stored
8182 in another NWB file and that file is linked to this file.
8283 quantity : ' ?'
@@ -87,17 +88,24 @@ groups:
8788 - num_files
8889 shape :
8990 - null
90- doc : Each entry is the frame number (within the full ImageSeries) of the first
91- frame in the corresponding external_file entry. This serves as an index to
92- what frames each file contains, allowing random access.Zero-based indexing
93- is used. (The first element will always be zero).
91+ doc : Each external image may contain one or more consecutive frames of the full
92+ ImageSeries. This attribute serves as an index to indicate which frames each file
93+ contains, to faciliate random access. The 'starting_frame' attribute, hence,
94+ contains a list of frame numbers within the full ImageSeries of the first frame
95+ of each file listed in the parent 'external_file' dataset. Zero-based indexing is
96+ used (hence, the first element will always be zero). For example, if the
97+ ' external_file' dataset has three paths to files and the first file has 5 frames,
98+ the second file has 10 frames, and the third file has 20 frames, then this
99+ attribute will have values [0, 5, 15]. If there is a single external file that
100+ holds all of the frames of the ImageSeries (and so there is a single element in
101+ the 'external_file' dataset), then this attribute should have value [0].
94102 - name : format
95103 dtype : text
96- doc : Format of image. If this is 'external' then the field external_file contains
97- the path or URL information to that file. For tiff, png, jpg, etc, the binary
98- representation of the image is stored in data . If the format is raw then the
99- fields bit_per_pixel and dimension are used. For raw images, only a single channel
100- is stored (e.g., red) .
104+ default_value : raw
105+ doc : Format of image. If this is 'external', then the attribute 'external_file'
106+ contains the path information to the image files . If this is ' raw', then the raw
107+ (single-channel) binary data is stored in the 'data' dataset. If this attribute
108+ is not present, then the default format='raw' case is assumed .
101109 quantity : ' ?'
102110
103111- neurodata_type_def : ImageMaskSeries
0 commit comments