diff options
| author | Tomas Farago <sensej007@email.cz> | 2021-12-07 07:55:51 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-07 07:55:51 +0100 |
| commit | 4c5d52debe42d0ad3d04df03e0bb462d11854b51 (patch) | |
| tree | 39bf684ae54299b42cb4b452808a3dd60ab4b9b6 /docs | |
| parent | 91b02da1880e71693b118e37da041f1126da356a (diff) | |
| parent | 9f49adb9b922cecc6cdabb437701a2005953b265 (diff) | |
| download | ufo-filters-4c5d52debe42d0ad3d04df03e0bb462d11854b51.tar.gz ufo-filters-4c5d52debe42d0ad3d04df03e0bb462d11854b51.tar.bz2 ufo-filters-4c5d52debe42d0ad3d04df03e0bb462d11854b51.tar.xz ufo-filters-4c5d52debe42d0ad3d04df03e0bb462d11854b51.zip | |
Merge pull request #216 from ufo-kit/image-step
Image step
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/generators.rst | 20 |
1 files changed, 8 insertions, 12 deletions
diff --git a/docs/generators.rst b/docs/generators.rst index 7e52fb0..d0925f5 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. @@ -80,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 ============= |