Skip to content

Commit

Permalink
Documentation: Improved documentation for loading .seq files
Browse files Browse the repository at this point in the history
  • Loading branch information
CSSFrancis committed Apr 6, 2023
1 parent f16dacf commit a340725
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion rsciio/de/_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ def file_reader(
celeritas: bool
If the data came from the celeritas camera. Important for loading
data saved with a prebuffer and split between top and bottom frames.
chunks: int, tuple, dict or str, optional
The new block dimensions to create. -1 indicates the full size of the
corresponding dimension. Default is “auto” which automatically determines chunk sizes.
distributed: bool
If the data should be loaded in a way that is supported by the
distributed backend. Slightly slower for smaller datasets but could
Expand Down Expand Up @@ -322,6 +325,14 @@ def read_data(
navigation_shape: None or tuple
Reads the data and then coerces it into the navigation shape
given
chunks: int, tuple, dict or str, optional
The new block dimensions to create. -1 indicates the full size of the
corresponding dimension. Default is “auto” which automatically determines chunk sizes.
distributed: bool
If the data should be loaded in a distributed compatible way. In many cases this is
preferred if you have a specific target chunking style.
lazy: bool
Whether to open the file lazily or not
"""
header = self._read_file_header()
dark_img, gain_img = self._read_dark_gain()
Expand Down Expand Up @@ -677,7 +688,6 @@ def read_stitch_binary_distributed(
dark=None,
gain=None,
):

indexes = get_chunk_index(
shape=shape,
signal_axes=(-1, -2),
Expand Down

0 comments on commit a340725

Please sign in to comment.