Skip to content

Label

Color #

Bases: BaseModel

A label value and RGBA as defined in https://ngff.openmicroscopy.org/0.4/#label-md

ImageLabel #

Bases: VersionedBase

image-label metadata. See https://ngff.openmicroscopy.org/0.4/#label-md

GroupAttrs #

Bases: MultiscaleGroupAttrs

Attributes for a Zarr group that contains image-label metadata. Inherits from v04.multiscales.MultiscaleAttrs.

See https://ngff.openmicroscopy.org/0.4/#label-md

Attributes:

Name Type Description
image_label `ImageLabel`

Image label metadata.
multiscales tuple[Multiscales]

Multiscale image metadata.

parse_imagelabel #

parse_imagelabel(model)

check that label_values are consistent across properties and colors

Source code in src/pydantic_ome_ngff/v04/label.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def parse_imagelabel(model: ImageLabel) -> ImageLabel:
    """
    check that label_values are consistent across properties and colors
    """
    if model.colors is not None and model.properties is not None:
        prop_label_value = [prop.label_value for prop in model.properties]
        color_label_value = [color.label_value for color in model.colors]

        prop_label_value_set = set(prop_label_value)
        color_label_value_set = set(color_label_value)
        if color_label_value_set != prop_label_value_set:
            msg = (
                "Inconsistent `label_value` attributes in `colors` and `properties`."
                f"The `properties` attributes have `label_values` {prop_label_value}, "
                f"The `colors` attributes have `label_values` {color_label_value}, "
            )
            raise ValueError(msg)
    return model