summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTomas Farago <sensej007@email.cz>2020-04-03 14:33:12 +0200
committerTomas Farago <sensej007@email.cz>2020-04-03 14:33:12 +0200
commit2f2dbf96c3075de062e73c655708af516773110c (patch)
treedec9d499c0e3d2b9922c6053315011dee2122830
parented5cc04ac7240d2a27e95fd8d9bcce5401d03c39 (diff)
downloadufo-filters-2f2dbf96c3075de062e73c655708af516773110c.tar.gz
ufo-filters-2f2dbf96c3075de062e73c655708af516773110c.tar.bz2
ufo-filters-2f2dbf96c3075de062e73c655708af516773110c.tar.xz
ufo-filters-2f2dbf96c3075de062e73c655708af516773110c.zip
Add multi-page parameters to writer docs
-rw-r--r--docs/sinks.rst14
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/sinks.rst b/docs/sinks.rst
index cc47d8f..943e478 100644
--- a/docs/sinks.rst
+++ b/docs/sinks.rst
@@ -13,7 +13,8 @@ File writer
Writes input data to the file system. Support for writing depends on compile
support, however raw (`.raw`) files can always be written. TIFF (`.tif` and
`.tiff`), HDF5 (`.h5`) and JPEG (`.jpg` and `.jpeg`) might be supported
- additionally.
+ additionally. By default, :gobj:prop:`bytes-per-file` is set to 128 GB, set
+ it to 0 if you want to write single-page files.
.. gobj:prop:: filename:string
@@ -35,6 +36,10 @@ File writer
Determines the number of steps the counter replacing the format
specifier is incremented. Initially, it is set to 1.
+ .. gobj:prop:: bytes-per-file:ulong
+
+ Bytes per file for multi-page files.
+
.. gobj:prop:: append:boolean
Append rather than overwrite if ``TRUE``.
@@ -71,6 +76,13 @@ File writer
JPEG quality value between 0 and 100. Higher values correspond to higher
quality and larger file sizes.
+ For TIFF files the following property applies:
+
+ .. gobj:prop:: tiff-bigtiff:boolean
+
+ Whether to write in BigTiff format (required for files larger than 4
+ GB).
+
Memory writer
=============