Skip to content

Commit aa7702e

Browse files
authored
Fix dims and shape of ImagingPlane and TwoPhotonSeries datasets (#445)
1 parent 25f1312 commit aa7702e

File tree

5 files changed

+27
-21
lines changed

5 files changed

+27
-21
lines changed

core/nwb.file.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ groups:
77
attributes:
88
- name: nwb_version
99
dtype: text
10-
value: 2.2.4
10+
value: 2.2.5
1111
doc: File version string. Use semantic versioning, e.g. 1.2.1. This will be the
1212
name of the format with trailing major, minor and patch numbers.
1313
datasets:

core/nwb.namespace.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ namespaces:
5757
- doc: This source module contains neurodata_type for retinotopy data.
5858
source: nwb.retinotopy.yaml
5959
title: Retinotopy
60-
version: 2.2.4
60+
version: 2.2.5

core/nwb.ophys.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ groups:
1717
- name: field_of_view
1818
dtype: float32
1919
dims:
20-
- width|height
21-
- width|height|depth
20+
- - width|height
21+
- - width|height|depth
2222
shape:
2323
- - 2
2424
- - 3
@@ -232,11 +232,11 @@ groups:
232232
- name: origin_coords
233233
dtype: float32
234234
dims:
235-
- x, y
236-
- x, y, z
235+
- - x, y
236+
- - x, y, z
237237
shape:
238-
- 2
239-
- 3
238+
- - 2
239+
- - 3
240240
doc: Physical location of the first element of the imaging plane (0, 0) for 2-D data or (0, 0, 0) for 3-D data.
241241
See also reference_frame for what the physical location is relative to (e.g., bregma).
242242
quantity: '?'
@@ -248,11 +248,11 @@ groups:
248248
- name: grid_spacing
249249
dtype: float32
250250
dims:
251-
- x, y
252-
- x, y, z
251+
- - x, y
252+
- - x, y, z
253253
shape:
254-
- 2
255-
- 3
254+
- - 2
255+
- - 3
256256
doc: Space between pixels in (x, y) or voxels in (x, y, z) directions, in the specified unit.
257257
Assumes imaging plane is a regular grid. See also reference_frame to interpret the grid.
258258
quantity: '?'

docs/format/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def run_doc_autogen(_):
3636

3737
def setup(app):
3838
app.connect('builder-inited', run_doc_autogen)
39-
app.add_stylesheet("theme_overrides.css") # overrides for wide tables in RTD theme
39+
app.add_css_file("theme_overrides.css") # overrides for wide tables in RTD theme
4040

4141

4242
# -- ext settings -----------------------------------------------------
@@ -83,7 +83,7 @@ def setup(app):
8383
# built documents.
8484
#
8585
# The short X.Y version.
86-
version = 'v2.2.4'
86+
version = 'v2.2.5'
8787
# The full version, including alpha/beta/rc tags.
8888
release = version
8989

docs/format/source/format_release_notes.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,36 @@
11
Release Notes
22
=============
33

4+
2.2.5 (May 29, 2020)
5+
----------------------
6+
7+
- Add schema validation CI.
8+
- Fix incorrect dims and shape for ``ImagingPlane.origin_coords`` and ``ImagingPlane.grid_spacing``, and fix incorrect dims for ``TwoPhotonSeries.field_of_view``.
9+
410
2.2.4 (April 14, 2020)
511
----------------------
612

7-
- Fix typo in nwb.ophys.yaml that prevents proper parsing of the schema.
13+
- Fix typo in ``nwb.ophys.yaml`` that prevents proper parsing of the schema.
814

915
2.2.3 (April 13, 2020)
1016
----------------------
1117

1218
- Move nested type definitions to root of YAML files. This does not functionally change the schema but simplifies parsing of the schema and extensions by APIs.
13-
- Make `ImagingPlane.imaging_rate` optional to handle cases where an imaging plane is associated with multiple time series with different rates.
19+
- Make ``ImagingPlane.imaging_rate`` optional to handle cases where an imaging plane is associated with multiple time series with different rates.
1420
- Add release process documentation.
1521

1622
2.2.2 (March 2, 2020)
1723
---------------------
1824

19-
- Fix shape and dims of `OpticalSeries.data` for color images
20-
- Allow more than one `OpticalChannel` object in `ImagingPlane`
21-
- Update hdmf-common-schema to 1.1.3. This fixes missing 'shape' and 'dims' key for types `VectorData`, `VectorIndex`, and `DynamicTableRegion`.
22-
- Revert changes to retinotopy.yaml in 2.1.0 which break backward compatibility and were not supported by the APIs in any case. Changes will be revisited in a future version.
25+
- Fix shape and dims of ``OpticalSeries.data`` for color images
26+
- Allow more than one ``OpticalChannel`` object in ``ImagingPlane``
27+
- Update hdmf-common-schema to 1.1.3. This fixes missing 'shape' and 'dims' key for types ``VectorData``, ``VectorIndex``, and ``DynamicTableRegion``.
28+
- Revert changes to ``nwb.retinotopy.yaml`` in 2.1.0 which break backward compatibility and were not supported by the APIs in any case. Changes will be revisited in a future version.
2329

2430
2.2.1 (January 14, 2020)
2531
------------------------
2632

27-
- Fixed incorrect version numbers in nwb.file.yaml and hdmf-common namespace.yaml.
33+
- Fixed incorrect version numbers in ``nwb.file.yaml`` and ``hdmf-common-schema/common/namespace.yaml``.
2834

2935
2.2.0 (January 6, 2020)
3036
-----------------------

0 commit comments

Comments
 (0)