Skip to content

Labels

ome_zarr_models.v05.labels.Labels

Bases: BaseGroupv05[LabelsAttrs]

An OME-Zarr labels dataset.

Attributes:

Name Type Description
zarr_format Literal[3]
node_type Literal['group']
attributes BaseZarrAttrs[LabelsAttrs]
members Mapping[str, GroupSpec | ArraySpec] | None

label_paths

label_paths: list[str]

List of paths to image-label groups within this labels group.

from_zarr

from_zarr(group: Group) -> Self

Create an OME-Zarr labels model from a zarr.Group.

Parameters:

Name Type Description Default
group Group

A Zarr group that has valid OME-Zarr label metadata.

required

get_image_labels_group

get_image_labels_group(path: str) -> ImageLabel

Get a image labels group at a given path.

ome_zarr_models.v05.labels.LabelsAttrs

Bases: BaseOMEAttrs

Attributes for an OME-Zarr labels dataset.

Attributes:

Name Type Description
version Literal['0.5']
labels list[str]

List of paths to labels arrays within a labels dataset.