From 2f2dbf96c3075de062e73c655708af516773110c Mon Sep 17 00:00:00 2001 From: Tomas Farago Date: Fri, 3 Apr 2020 14:33:12 +0200 Subject: Add multi-page parameters to writer docs --- docs/sinks.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) 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 ============= -- cgit v1.2.1