Skip to content

Update readme to include --linear16to8 #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chris-allan merged 1 commit into from
Sep 19, 2025
Merged

Update readme to include --linear16to8 #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,18 @@ Use of the Zarr file type will result in losslessly compressed output. This
is the only format currently supported by the downstream `raw2ometiff` (as of
version 0.3.0).

## Supported data types

Brightfield RGB with 8 bits per component is supported in all versions.

Brightfield RGB with 16 bits per component is supported in 0.7.0 and later.
By default, all 16 bits per component are converted. If 8 bit output is required
instead, the `--linear16to8` option can be used to convert to 8 bit before
writing to Zarr. This is performed using the `Linear16ToSRGB8` filter built in
to the Philips SDK.

Any other data types are not currently supported.

## Background color

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

The iSyntax converter is distributed under the terms of the BSD license.
Please see `LICENSE.txt` for further details.

## Areas to improve

* Currently assumes brightfield (RGB, 8 bits per channel) without really
checking the metadata. Probably should check bit depths etc.