From a34072514b06cee695635b0489160bd34ca2f4b2 Mon Sep 17 00:00:00 2001 From: cssfrancis Date: Thu, 6 Apr 2023 09:34:10 -0500 Subject: [PATCH] Documentation: Improved documentation for loading .seq files --- rsciio/de/_api.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/rsciio/de/_api.py b/rsciio/de/_api.py index be8e6ab3c..510063e0e 100644 --- a/rsciio/de/_api.py +++ b/rsciio/de/_api.py @@ -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 @@ -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() @@ -677,7 +688,6 @@ def read_stitch_binary_distributed( dark=None, gain=None, ): - indexes = get_chunk_index( shape=shape, signal_axes=(-1, -2),