NeurodataWithoutBorders / pynwb

A Python API for working with Neurodata stored in the NWB Format
https://pynwb.readthedocs.io
Other
178 stars 84 forks source link

[Feature]: Non-square pixel support for GrayscaleImage, ImageSeries, etc. #1749

Open pauladkisson opened 1 year ago

pauladkisson commented 1 year ago

What would you like to see added to PyNWB?

I have behavioral video and some static images with different estimated length (mm/pixel) than width (mm/pixel). I would like to specify this in the images/ImageSeries' but there is only a scalar resolution field.

Is your feature request related to a problem?

No response

What solution would you like?

All image neurodata_types should implement a grid_spacing like pynwb.ophys.ImagingPlane.

Do you have any interest in helping implement the feature?

Yes.

Code of Conduct

CodyCBakerPhD commented 1 year ago

@pauladkisson Thanks, could you also raise an issue on https://github.com/NeurodataWithoutBorders/nwb-schema/issues for the core schema change (which will also affect MatNWB)

Specific to here on PyNWB, the inits to all of the affected classes could be made to take the classic scalar and assume the effect is square, such that the change to allow a tuple or list as input is seen as a new feature not a break to compatability