Skip to content

Commit

Permalink
add note to imaging extractor
Browse files Browse the repository at this point in the history
  • Loading branch information
h-mayorquin committed Sep 15, 2023
1 parent a96afc2 commit 7cc8d80
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/roiextractors/imagingextractor.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,25 @@ def get_video(
-------
video: numpy.ndarray
The video frames.
Notes:
------
This is the central extraction function for the ImagingExtractor instances.
It should fetch the requested frames from the instance format.
Importantly, we follow the convention that the dimensions of the array are returned in their matrix order,
More specifically:
(frames or time, height or rows, width or columns, depth or volume)
Note that this does not match the cartesian convention:
(t, x, y, z)
Where x is the columns width or and y is the rows or height.
It is important to check for each format what is the convention used and to transpose the data to the
roi convention if needed.
"""
pass

Expand Down

0 comments on commit 7cc8d80

Please sign in to comment.