Skip to content

Commit

Permalink
Merge branch 'main' into docstring_checker
Browse files Browse the repository at this point in the history
  • Loading branch information
CodyCBakerPhD authored Oct 19, 2023
2 parents a0029f3 + 8aa0c11 commit 3d653df
Showing 1 changed file with 14 additions and 0 deletions.
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

0 comments on commit 3d653df

Please sign in to comment.