Rendering

get_image_display_settings

get_image_display_settings

get_image_display_settings(metadata: dict) -> ImageDisplaySettings

Return normalized channel/display settings from image metadata.

Parameters:

Name	Type	Description	Default
metadata	dict	Metadata dict as returned by :func:get_image_metadata.	required

Returns:

Type	Description
ImageDisplaySettings	Dataclass with channels, default_z, and default_t.

ImageDisplaySettings

ImageDisplaySettings dataclass

ImageDisplaySettings(channels: list[ChannelDisplay], default_z: int = 0, default_t: int = 0)

Normalized image display settings derived from OMERO metadata.

Attributes:

Name	Type	Description
channels	list[ChannelDisplay]	One entry per channel with colour, window, and active state.
default_z	int	Server-suggested default Z-plane.
default_t	int	Server-suggested default timepoint.

ChannelDisplay

ChannelDisplay dataclass

ChannelDisplay(index: int, name: str, color: tuple[int, int, int] | None = None, emission_wavelength: float | None = None, active: bool = True, window_start: float | None = None, window_end: float | None = None)

Normalized per-channel display information.

Attributes:

Name	Type	Description
index	int	Zero-based channel index.
name	str	Channel label (e.g. "DAPI", "GFP").
color	tuple[int, int, int] | None	RGB colour as (R, G, B) integers 0–255.
emission_wavelength	float | None	Emission wavelength in nm, if available.
active	bool	Whether the channel is toggled on by default.
window_start	float | None	Contrast window lower bound (intensity value).
window_end	float | None	Contrast window upper bound (intensity value).