From 257d478716ea12edde575382feeac175ac5f2f3d Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 7 Feb 2025 10:27:14 +0000 Subject: [PATCH 1/3] Make omero.channel values optional (MAY) --- 0.5/index.bs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/0.5/index.bs b/0.5/index.bs index ffc7cf57..a6606d20 100644 --- a/0.5/index.bs +++ b/0.5/index.bs @@ -382,10 +382,10 @@ See the [OMERO WebGateway documentation](https://omero.readthedocs.io/en/stable/ for more information. The "omero" metadata is optional, but if present it MUST contain the field "channels", which is an array of dictionaries describing the channels of the image. -Each dictionary in "channels" MUST contain the field "color", which is a string of 6 hexadecimal digits specifying the color of the channel in RGB format. -Each dictionary in "channels" MUST contain the field "window", which is a dictionary describing the windowing of the channel. -The field "window" MUST contain the fields "min" and "max", which are the minimum and maximum values of the window, respectively. -It MUST also contain the fields "start" and "end", which are the start and end values of the window, respectively. +Each dictionary in "channels" MAY contain the field "color", which is a string of 6 hexadecimal digits specifying the color of the channel in RGB format. +Each dictionary in "channels" MAY contain the field "window", which is a dictionary describing the windowing of the channel. +The field "window" MAY contain the fields "min" and "max", which should correspond to the minimum and maximum pixel intensities for that channel, respectively. +It MAY also contain the fields "start" and "end", which are the suggested start and end rendering settings of the window, respectively. "labels" metadata {#labels-md} ------------------------------ From 80cfe0835d2ccdf1db9627f96394938e6f27376c Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 7 Feb 2025 10:41:25 +0000 Subject: [PATCH 2/3] Add descriptions of channel label, active, inverted. Channels length SHOULD be sizeC --- 0.5/index.bs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/0.5/index.bs b/0.5/index.bs index a6606d20..e631c2d0 100644 --- a/0.5/index.bs +++ b/0.5/index.bs @@ -382,10 +382,14 @@ See the [OMERO WebGateway documentation](https://omero.readthedocs.io/en/stable/ for more information. The "omero" metadata is optional, but if present it MUST contain the field "channels", which is an array of dictionaries describing the channels of the image. +The "channels" array length SHOULD correspond to the size of the "c" axis. Each dictionary in "channels" MAY contain the field "color", which is a string of 6 hexadecimal digits specifying the color of the channel in RGB format. +Each dictionary in "channels" MAY contain the field "label", which is a string and a boolean "active" field to indicate whether the channel +should be displayed. Each dictionary in "channels" MAY contain the field "window", which is a dictionary describing the windowing of the channel. The field "window" MAY contain the fields "min" and "max", which should correspond to the minimum and maximum pixel intensities for that channel, respectively. It MAY also contain the fields "start" and "end", which are the suggested start and end rendering settings of the window, respectively. +Each dictionary in "channels" MAY contain the boolean field "inverted". If true, the renderinging of darkest to brightest pixels should be inverted. "labels" metadata {#labels-md} ------------------------------ From 9097eba992fa5a23f4fc23fac0fae20fdfd7db21 Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 7 Feb 2025 11:00:30 +0000 Subject: [PATCH 3/3] List channel vaulues as bullet-points. Add notes on window values --- 0.5/index.bs | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/0.5/index.bs b/0.5/index.bs index e631c2d0..6d5fbbb2 100644 --- a/0.5/index.bs +++ b/0.5/index.bs @@ -383,13 +383,19 @@ for more information. The "omero" metadata is optional, but if present it MUST contain the field "channels", which is an array of dictionaries describing the channels of the image. The "channels" array length SHOULD correspond to the size of the "c" axis. -Each dictionary in "channels" MAY contain the field "color", which is a string of 6 hexadecimal digits specifying the color of the channel in RGB format. -Each dictionary in "channels" MAY contain the field "label", which is a string and a boolean "active" field to indicate whether the channel -should be displayed. -Each dictionary in "channels" MAY contain the field "window", which is a dictionary describing the windowing of the channel. -The field "window" MAY contain the fields "min" and "max", which should correspond to the minimum and maximum pixel intensities for that channel, respectively. -It MAY also contain the fields "start" and "end", which are the suggested start and end rendering settings of the window, respectively. -Each dictionary in "channels" MAY contain the boolean field "inverted". If true, the renderinging of darkest to brightest pixels should be inverted. +Each dictionary in "channels" MAY contain the following fields: + +- "color" (string) String of 6 hexadecimal digits specifying the color of the channel in RGB format. +- "label" (string) Channel name. +- "active" (boolean) Indicates whether the channel should be displayed. +- "window" (dictionary) Values describing the windowing of the channel. All values are optional (MAY). + The "min" and "max" values may be used by viewers as the range of channel sliders. + All values can be floating-point numbers, but will likely be integers for integer pixel types. + - "min" (float) Should correspond to the minimum pixel intensity for that channel. + - "max" (float) Should correspond to the maximum pixel intensity for that channel. + - "start" (float) Start of the rendering window. + - "end" (float) End of the rendering window. +- "inverted" (boolean) If true, the rendering of darkest to brightest pixels should be inverted. "labels" metadata {#labels-md} ------------------------------