Skip to content

Commit add1ea0

Browse files
authored
Merge pull request #44 from melissalinkert/readme-updates
Update readme to include `--linear16to8`
2 parents b3d1256 + 296b998 commit add1ea0

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,18 @@ Use of the Zarr file type will result in losslessly compressed output. This
3636
is the only format currently supported by the downstream `raw2ometiff` (as of
3737
version 0.3.0).
3838

39+
## Supported data types
40+
41+
Brightfield RGB with 8 bits per component is supported in all versions.
42+
43+
Brightfield RGB with 16 bits per component is supported in 0.7.0 and later.
44+
By default, all 16 bits per component are converted. If 8 bit output is required
45+
instead, the `--linear16to8` option can be used to convert to 8 bit before
46+
writing to Zarr. This is performed using the `Linear16ToSRGB8` filter built in
47+
to the Philips SDK.
48+
49+
Any other data types are not currently supported.
50+
3951
## Background color
4052

4153
Any missing tiles are filled with 0 by default, which displays as black.
@@ -67,8 +79,3 @@ relative performance.
6779

6880
The iSyntax converter is distributed under the terms of the BSD license.
6981
Please see `LICENSE.txt` for further details.
70-
71-
## Areas to improve
72-
73-
* Currently assumes brightfield (RGB, 8 bits per channel) without really
74-
checking the metadata. Probably should check bit depths etc.

0 commit comments

Comments
 (0)