From 32f25d2f2095c13110640f27c99d0c95f2d49255 Mon Sep 17 00:00:00 2001 From: Tomas Farago Date: Wed, 1 Dec 2021 16:31:11 +0100 Subject: read: add image-start and image-step properties to skip images in multi-image files. Fixes #164. --- docs/generators.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs') diff --git a/docs/generators.rst b/docs/generators.rst index 7e52fb0..9f063ab 100644 --- a/docs/generators.rst +++ b/docs/generators.rst @@ -34,10 +34,18 @@ File reader First index from where files are read. + .. gobj:prop:: image-start:uint + + First image index from where images are read in multi-image files. + .. gobj:prop:: step:uint Number of files to skip. + .. gobj:prop:: image-step:uint + + Number of images to skip in a multi-image file. + .. gobj:prop:: y:uint Vertical coordinate from where to start reading. -- cgit v1.2.1 From 9f49adb9b922cecc6cdabb437701a2005953b265 Mon Sep 17 00:00:00 2001 From: Tomas Farago Date: Fri, 3 Dec 2021 14:36:46 +0100 Subject: docs: remove retries and retry-timeout --- docs/generators.rst | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/generators.rst b/docs/generators.rst index 9f063ab..d0925f5 100644 --- a/docs/generators.rst +++ b/docs/generators.rst @@ -88,18 +88,6 @@ File reader example, to load `.foo` files as raw files, set the ``type`` property to `raw`. - .. gobj:prop:: retries:uint - - Set the number of retries in case files do not exist yet and are being - written. If you set this, you *must* also set ``number`` otherwise you - would have to wait basically forever for the execution to finish. Note, - that only files are considered which come after the last successful - filename. - - .. gobj:prop:: retry-timeout:uint - - Seconds to wait before reading new files. - Memory reader ============= -- cgit v1.2.1