Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about get_video convention to ImagingExtractor #244

Merged
merged 9 commits into from
Oct 19, 2023
14 changes: 14 additions & 0 deletions src/roiextractors/imagingextractor.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,20 @@ def get_video(
-------
video: numpy.ndarray
The video frames.

Notes
-----
Importantly, we follow the convention that the dimensions of the array are returned in their matrix order,
More specifically:
(time, height, width)

Which is equivalent to:
(samples, rows, columns)

Note that this does not match the cartesian convention:
(t, x, y)

Where x is the columns width or and y is the rows or height.
"""
pass

Expand Down
Loading