Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description of ImagingPlane is required by PyNWB, but not schema #2049

Open
ehennestad opened this issue Mar 3, 2025 · 2 comments · May be fixed by #2051
Open

Description of ImagingPlane is required by PyNWB, but not schema #2049

ehennestad opened this issue Mar 3, 2025 · 2 comments · May be fixed by #2051
Labels
category: bug errors in the code or code behavior
Milestone

Comments

@ehennestad
Copy link

ehennestad commented Mar 3, 2025

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.

@rly
Copy link
Contributor

rly commented Mar 4, 2025

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 rly added the category: bug errors in the code or code behavior label Mar 4, 2025
@oruebel
Copy link
Contributor

oruebel commented Mar 4, 2025

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

@rly rly added this to the Future milestone Mar 4, 2025
@rly rly linked a pull request Mar 4, 2025 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: bug errors in the code or code behavior
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants