pynwb icon indicating copy to clipboard operation
pynwb copied to clipboard

Description of ImagingPlane is required by PyNWB, but not schema

Open ehennestad opened this issue 9 months ago • 2 comments

I noticed that description is a required property of ImagingPlane in PyNWB. In the schema it is listed as optional:

https://github.com/NeurodataWithoutBorders/nwb-schema/blob/5cfe01d428bb432a51f139412fcf60d1a1dfac08/core/nwb.ophys.yaml#L204-L211

This causes an incompatibility between files created by MatNWB, where they can not be read by PyNWB if the ImagingPlane/description is not set.

ehennestad avatar Mar 03 '25 23:03 ehennestad

That's a bug. We should fix that but note that some users who are creating an ImagingPlane without kwargs would get misordered arguments after this fix.

rly avatar Mar 04 '25 17:03 rly

Alternatively, you could set description to an empty string the object-mapper if it is missing on read.

oruebel avatar Mar 04 '25 17:03 oruebel