Skip to content

Commit 7dfa735

Browse files
committed
Documentation: Improved documentation for loading .seq files
1 parent f16dacf commit 7dfa735

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

rsciio/de/_api.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ def file_reader(
6767
celeritas: bool
6868
If the data came from the celeritas camera. Important for loading
6969
data saved with a prebuffer and split between top and bottom frames.
70+
chunks: int, tuple, dict or str, optional
71+
The new block dimensions to create. -1 indicates the full size of the
72+
corresponding dimension. Default is “auto” which automatically determines chunk sizes.
7073
distributed: bool
7174
If the data should be loaded in a way that is supported by the
7275
distributed backend. Slightly slower for smaller datasets but could
@@ -322,6 +325,14 @@ def read_data(
322325
navigation_shape: None or tuple
323326
Reads the data and then coerces it into the navigation shape
324327
given
328+
chunks: int, tuple, dict or str, optional
329+
The new block dimensions to create. -1 indicates the full size of the
330+
corresponding dimension. Default is “auto” which automatically determines chunk sizes.
331+
distributed: bool
332+
If the data should be loaded in a distributed compatible way. In many cases this is
333+
preferred if you have a specific target chunking style.
334+
lazy: bool
335+
Whether to open the file lazily or not
325336
"""
326337
header = self._read_file_header()
327338
dark_img, gain_img = self._read_dark_gain()

0 commit comments

Comments
 (0)