Skip to content

Commit 296b998

Browse files
Update readme to include --linear16to8
1 parent 6748a70 commit 296b998

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

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

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

4355
Any missing tiles are filled with 0 by default, which displays as black.
@@ -69,8 +81,3 @@ relative performance.
6981

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

0 commit comments

Comments
 (0)