Skip to content

Commit 519b229

Browse files
committed
omero metadata fields are all optional
Ported from ome/ngff#297
1 parent 17486d0 commit 519b229

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

ngff_spec/specification.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1462,16 +1462,22 @@ if not datasets:
14621462
See the [OMERO WebGateway documentation](https://omero.readthedocs.io/en/stable/developers/Web/WebGateway.html#imgdata)
14631463
for more information.
14641464

1465-
The "omero" metadata is optional, but if present it MUST contain the field "channels",
1465+
The `omero` metadata is optional, but if present it MUST contain the field `channels`,
14661466
which is an array of dictionaries describing the channels of the image.
1467-
Each dictionary in "channels" MUST contain the field "color",
1468-
which is a string of 6 hexadecimal digits specifying the color of the channel in RGB format.
1469-
Each dictionary in "channels" MUST contain the field "window",
1470-
which is a dictionary describing the windowing of the channel.
1471-
The field "window" MUST contain the fields "min" and "max",
1472-
which are the minimum and maximum values of the window, respectively.
1473-
It MUST also contain the fields "start" and "end",
1474-
which are the start and end values of the window, respectively.
1467+
The `channels` array length SHOULD correspond to the size of the `c` axis.
1468+
Each dictionary in `channels` MAY contain the following fields:
1469+
1470+
- `color` (string) String of 6 hexadecimal digits specifying the color of the channel in RGB format.
1471+
- `label` (string) Channel name.
1472+
- `active` (boolean) Indicates whether the channel should be displayed.
1473+
- `window` (dictionary) Values describing the windowing of the channel. All values are optional (MAY).
1474+
The `min` and `max` values may be used by viewers as the range of channel sliders.
1475+
All values can be floating-point numbers, but will likely be integers for integer pixel types.
1476+
- `min` (float) Should correspond to the minimum pixel intensity for that channel.
1477+
- `max` (float) Should correspond to the maximum pixel intensity for that channel.
1478+
- `start` (float) Start of the rendering window.
1479+
- `end` (float) End of the rendering window.
1480+
- `inverted` (boolean) If true, the rendering of darkest to brightest pixels should be inverted.
14751481

14761482
## "labels" metadata
14771483
(labels-md)=

0 commit comments

Comments
 (0)