catalystneuro / roiextractors

Python-based module for extracting from, converting between, and handling optical imaging data from several file formats. Inspired by SpikeInterface.
https://roiextractors.readthedocs.io/en/latest/index.html
BSD 3-Clause "New" or "Revised" License
12 stars 7 forks source link

Multi-Plane and Multi-Channel Support for ScanImage #253

Closed pauladkisson closed 1 year ago

pauladkisson commented 1 year ago

Fixes #240 Continues from #241 rebased from #248

pauladkisson commented 1 year ago

The one thing that I never really figured out is how to deal with the times for the volumetric imaging. Still not really sure how that should be represented. Right now the times are accessible in each SinglePlaneImagingExtractor. Other than that this should be good to go.

CodyCBakerPhD commented 1 year ago

The one thing that I never really figured out is how to deal with the times for the volumetric imaging. Still not really sure how that should be represented.

It looks like our base classes themselves still need to be updated to the latest SI standard (get_times) so fine to leave that as a follow-up

I know we talked about having an array of times to indicate the shifts for each plane, but for consistency with the other methods like get_video, I think the simplest return for such a function would just be the timestamps of the first plane capture in each volume, for each frame

Then we can talk about a separate method for volumes that returns a more detailed structure and get feedback from the rest of the team on that

CodyCBakerPhD commented 1 year ago

This LGTM, very well tested!

@alessandratrapani How does it look to you?

codecov[bot] commented 1 year ago

Codecov Report

Merging #253 (2d4a19b) into main (8884c93) will increase coverage by 1.41%. Report is 1 commits behind head on main. The diff coverage is 99.49%.

:exclamation: Current head 2d4a19b differs from pull request most recent head 51fe69e. Consider uploading reports for the commit 51fe69e to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #253      +/-   ##
==========================================
+ Coverage   77.55%   78.96%   +1.41%     
==========================================
  Files          38       39       +1     
  Lines        2793     2985     +192     
==========================================
+ Hits         2166     2357     +191     
- Misses        627      628       +1     
Flag Coverage Δ
unittests 78.96% <99.49%> (+1.41%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/roiextractors/extractorlist.py 100.00% <ø> (ø)
...ctors/extractors/tiffimagingextractors/__init__.py 100.00% <100.00%> (ø)
...ctors/tiffimagingextractors/scanimagetiff_utils.py 100.00% <100.00%> (ø)
...imagingextractors/scanimagetiffimagingextractor.py 98.96% <99.29%> (+0.69%) :arrow_up: