Skip to content

Commit

Permalink
Add multi-page parameters to writer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tfarago committed Apr 3, 2020
1 parent ed5cc04 commit 2f2dbf9
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/sinks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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``.
Expand Down Expand Up @@ -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
=============
Expand Down

0 comments on commit 2f2dbf9

Please sign in to comment.