diff options
| author | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2017-09-05 14:11:36 +0200 |
|---|---|---|
| committer | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2017-09-05 14:11:36 +0200 |
| commit | 92be65b780023a4e2aa1c886e6db458b40627eb1 (patch) | |
| tree | a8f4d3dc06a9594a76b62b0c0ab0a1ba104d550b /docs | |
| parent | fbe03519f7284dce44d8408e8abb3266e846dc10 (diff) | |
| download | ufo-filters-92be65b780023a4e2aa1c886e6db458b40627eb1.tar.gz ufo-filters-92be65b780023a4e2aa1c886e6db458b40627eb1.tar.bz2 ufo-filters-92be65b780023a4e2aa1c886e6db458b40627eb1.tar.xz ufo-filters-92be65b780023a4e2aa1c886e6db458b40627eb1.zip | |
write: add counter-start and counter-step
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sinks.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/sinks.rst b/docs/sinks.rst index c381f89..d4135da 100644 --- a/docs/sinks.rst +++ b/docs/sinks.rst @@ -25,6 +25,16 @@ File writer file (i.e. multi-tiff, HDF5 data set). If no filename is given the data is written as-is to stdout. + .. gobj:prop:: counter-start:uint + + Sets the counter that replaces the format specifier. Initially, it is + set to 0. + + .. gobj:prop:: counter-step:uint + + Determines the number of steps the counter replacing the format + specifier is incremented. Initially, it is set to 1. + .. gobj:prop:: append:boolean Append rather than overwrite if ``TRUE``. |