pynwb icon indicating copy to clipboard operation
pynwb copied to clipboard

`ImagingPlane` API docs claims that excitation lambda can be None in contradiction with the schema

Open h-mayorquin opened this issue 4 months ago • 2 comments

The signature of ImagingPlane is here:

https://pynwb.readthedocs.io/en/stable/pynwb.ophys.html#pynwb.ophys.ImagingPlane

In the API docs the ImagingPlane indicates that excitation lambda can be equal to None but this is no the case in the schema

https://github.com/NeurodataWithoutBorders/nwb-schema/blob/ade50ef33446beb3c7df4c6f1072ae0e821b5115/core/nwb.ophys.yaml#L216-L217

The API here in pynwb does not allow it either so it seems that this only a documentation issue.

h-mayorquin avatar Aug 19 '25 18:08 h-mayorquin

See comments in https://github.com/NeurodataWithoutBorders/pynwb/blob/387f80bd621d4e33a72abc177122c72c546c4321/src/pynwb/ophys.py#L134-L146

This will be fixed in PyNWB 4.0 when positional arguments are no longer allowed for ImagingPlane.__init__.

rly avatar Aug 19 '25 22:08 rly

Thanks, this makes sense.

h-mayorquin avatar Aug 19 '25 22:08 h-mayorquin