pynwb
pynwb copied to clipboard
Add support for reading external ImageSeries
2) Feature Request
ImageSeries allows specification of data via external_file image stacks. It would be useful to enhance the ImageSeries Container class in PyNWB to support reading of ImageSeries from these external image stacks. Currently this is up to the user. Specifically we should
- Improve documentation of
external_fileandstarting_frameto clarify the use and meaning of the fields, supported external formats etc. Both in the API and schema - Add class
ExternalImageStackthat encapsulates an external image stack and allows reading from a stack of images - Update
ImageSeries.datato support providing anExternalImageStackas input to simplify creating anImageSeriesfor an external image stack - Add helper function
ExternalImageStack.from_dirto create theexternal_fileandstarting_framefields for theImageSeriesand simplify using external image stacks with fixed filename conventions
Problem/Use Case
Image acquisition systems often store image stacks in standard TIFF image stacks. NWB supports this in ImageSeries by allowing include of the stacks directly, rather than copy of the data. This feature would users with interacting with those external image stacks.
CC: @nclack @ln-vidrio
Checklist
- [X] Have you ensured the feature or change was not already reported ?
- [X] Have you included a brief and descriptive title?
- [X] Have you included a clear description of the problem you are trying to solve?
- [ ] Have you included a minimal code snippet that reproduces the issue you are encountering?
- [X] Have you checked our Contributing document?