diff options
| author | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2017-01-27 15:27:52 +0100 |
|---|---|---|
| committer | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2017-01-27 15:27:52 +0100 |
| commit | 1d5e54b2747978a501e1e001a48a31c08d5b70fe (patch) | |
| tree | 12621c98a7092ebbe3f78a89e6c5dc7fbed0864d /docs | |
| parent | 7564fa0f767958f2d8c90de5d4fc74842466a49b (diff) | |
| download | ufo-filters-1d5e54b2747978a501e1e001a48a31c08d5b70fe.tar.gz ufo-filters-1d5e54b2747978a501e1e001a48a31c08d5b70fe.tar.bz2 ufo-filters-1d5e54b2747978a501e1e001a48a31c08d5b70fe.tar.xz ufo-filters-1d5e54b2747978a501e1e001a48a31c08d5b70fe.zip | |
write: add minimum/maximum to control conversion
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sinks.rst | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/sinks.rst b/docs/sinks.rst index 41dc982..9ff7d7c 100644 --- a/docs/sinks.rst +++ b/docs/sinks.rst @@ -32,7 +32,19 @@ File writer Number of bits to store the data if applicable to the file format. Possible values are 8 and 16 which are saved as integer types and 32 bit - float. + float. By default, the minimum and maximum for scaling is determined + automatically, however depending on the use case you should override + this with the ``minimum`` and ``maximum`` properties. + + .. gobj:prop:: minimum:float + + This value will represent zero for discrete bit depths, i.e. 8 and 16 + bit. + + .. gobj:prop:: minimum:float + + This value will represent the largest possible value for discrete bit + depths, i.e. 8 and 16 bit. For JPEG files the following property applies: |