ngio 0.5.0a3__tar.gz → 0.5.0b1__tar.gz

{ngio-0.5.0a3 → ngio-0.5.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngio
-Version: 0.5.0a3
+Version: 0.5.0b1
 Summary: Next Generation file format IO
 Project-URL: homepage, https://github.com/BioVisionCenter/ngio
 Project-URL: repository, https://github.com/BioVisionCenter/ngio

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/images/_abstract_image.py

@@ -681,7 +681,7 @@ def _check_chunks_and_shards_compatibility(
 
 def _apply_channel_policy(
     ref_image: AbstractImage,
-    channels_policy: Literal["squeeze", "same"] | int,
+    channels_policy: Literal["squeeze", "same", "singleton"] | int,
     shapes: list[tuple[int, ...]],
     axes: tuple[str, ...],
     chunks: ChunksLike,
@@ -703,6 +703,10 @@ def _apply_channel_policy(
     if channels_policy == "same":
         return shapes, axes, chunks, shards
 
+    if channels_policy == "singleton":
+        # Treat 'singleton' as setting channel size to 1
+        channels_policy = 1
+
     channel_index = ref_image.axes_handler.get_index("c")
     if channel_index is None:
         if channels_policy == "squeeze":
@@ -729,11 +733,6 @@ def _apply_channel_policy(
     elif isinstance(channels_policy, int):
         new_shapes = []
         for shape in shapes:
-            if shape[channel_index] != channels_policy:
-                raise NgioValueError(
-                    f"Cannot apply channel policy {channels_policy=} to an image "
-                    f"with {shape[channel_index]} channels."
-                )
             new_shape = (
                 *shape[:channel_index],
                 channels_policy,
@@ -797,7 +796,7 @@ def abstract_derive(
     z_spacing: float | None = None,
     time_spacing: float | None = None,
     name: str | None = None,
-    channels_policy: Literal["squeeze", "same"] | int = "same",
+    channels_policy: Literal["squeeze", "same", "singleton"] | int = "same",
     channels_meta: Sequence[str | Channel] | None = None,
     ngff_version: NgffVersions | None = None,
     # Zarr Array parameters
@@ -826,9 +825,11 @@ def abstract_derive(
         time_spacing (float | None): The time spacing of the new image.
         axes_names (Sequence[str] | None): The axes names of the new image.
         name (str | None): The name of the new image.
-        channels_policy (Literal["squeeze", "same"] | int): Possible policies:
+        channels_policy (Literal["squeeze", "same", "singleton"] | int):
+            Possible policies:
             - If "squeeze", the channels axis will be removed (no matter its size).
             - If "same", the channels axis will be kept as is (if it exists).
+            - If "singleton", the channels axis will be set to size 1.
             - If an integer is provided, the channels axis will be changed to have that
                 size.
         channels_meta (Sequence[str | Channel] | None): The channels metadata

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/images/_image.py

@@ -765,6 +765,7 @@ def derive_image_container(
     z_spacing: float | None = None,
     time_spacing: float | None = None,
     name: str | None = None,
+    channels_policy: Literal["same", "squeeze", "singleton"] | int = "same",
     channels_meta: Sequence[str | Channel] | None = None,
     ngff_version: NgffVersions | None = None,
     # Zarr Array parameters
@@ -793,6 +794,13 @@ def derive_image_container(
         z_spacing (float | None): The z spacing of the new image.
         time_spacing (float | None): The time spacing of the new image.
         name (str | None): The name of the new image.
+        channels_policy (Literal["squeeze", "same", "singleton"] | int): Possible
+            policies:
+            - If "squeeze", the channels axis will be removed (no matter its size).
+            - If "same", the channels axis will be kept as is (if it exists).
+            - If "singleton", the channels axis will be set to size 1.
+            - If an integer is provided, the channels axis will be changed to have
+                that size.
         channels_meta (Sequence[str | Channel] | None): The channels metadata
             of the new image.
         ngff_version (NgffVersions | None): The NGFF version to use.
@@ -826,7 +834,7 @@ def derive_image_container(
         time_spacing=time_spacing,
         name=name,
         channels_meta=channels_meta,
-        channels_policy="same",
+        channels_policy=channels_policy,
         ngff_version=ngff_version,
         chunks=chunks,
         shards=shards,

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/images/_label.py

@@ -11,8 +11,11 @@ from ngio.images._abstract_image import AbstractImage, abstract_derive
 from ngio.images._image import Image
 from ngio.ome_zarr_meta import (
     LabelMetaHandler,
+    LabelsGroupMetaHandler,
     NgioLabelMeta,
+    NgioLabelsGroupMeta,
     PixelSize,
+    update_ngio_labels_group_meta,
 )
 from ngio.ome_zarr_meta.ngio_specs import (
     DefaultSpaceUnit,
@@ -112,29 +115,39 @@ class Label(AbstractImage):
 class LabelsContainer:
     """A class to handle the /labels group in an OME-NGFF file."""
 
-    def __init__(self, group_handler: ZarrGroupHandler) -> None:
+    def __init__(
+        self,
+        group_handler: ZarrGroupHandler,
+        ngff_version: NgffVersions | None = None,
+    ) -> None:
         """Initialize the LabelGroupHandler."""
         self._group_handler = group_handler
-        # Validate the group
-        # Either contains a labels attribute or is empty
-        attrs = self._group_handler.load_attrs()
-        if len(attrs) == 0:
-            # It's an empty group
-            pass
-        elif "labels" in attrs and isinstance(attrs["labels"], list):
-            # It's a valid group
-            pass
-        else:
-            raise NgioValidationError(
-                f"Invalid /labels group. "
-                f"Expected a single labels attribute with a list of label names. "
-                f"Found: {attrs}"
+        # If the group is empty, initialize the metadata
+        try:
+            self._meta_handler = LabelsGroupMetaHandler(group_handler)
+        except NgioValidationError:
+            if ngff_version is None:
+                raise NgioValueError(
+                    "The /labels group is missing metadata. "
+                    "Please provide the ngff_version to initialize it."
+                ) from None
+            meta = NgioLabelsGroupMeta(labels=[], version=ngff_version)
+            update_ngio_labels_group_meta(
+                group_handler=group_handler,
+                ngio_meta=meta,
             )
+            self._group_handler = self._group_handler.reopen_handler()
+            self._meta_handler = LabelsGroupMetaHandler(group_handler)
+
+    @property
+    def meta(self) -> NgioLabelsGroupMeta:
+        """Return the metadata."""
+        meta = self._meta_handler.get_meta()
+        return meta
 
     def list(self) -> list[str]:
         """Create the /labels group if it doesn't exist."""
-        attrs = self._group_handler.load_attrs()
-        return attrs.get("labels", [])
+        return self.meta.labels
 
     def get(
         self,
@@ -178,7 +191,7 @@ class LabelsContainer:
         pixelsize: float | tuple[float, float] | None = None,
         z_spacing: float | None = None,
         time_spacing: float | None = None,
-        channels_policy: Literal["same", "squeeze"] | int = "squeeze",
+        channels_policy: Literal["same", "squeeze", "singleton"] | int = "squeeze",
         ngff_version: NgffVersions | None = None,
         # Zarr Array parameters
         chunks: ChunksLike = "auto",
@@ -210,9 +223,11 @@ class LabelsContainer:
             name (str | None): The name of the new image.
             channels_meta (Sequence[str | Channel] | None): The channels metadata
                 of the new image.
-            channels_policy (Literal["squeeze", "same"] | int): Possible policies:
+            channels_policy (Literal["squeeze", "same", "singleton"] | int):
+                Possible policies:
                 - If "squeeze", the channels axis will be removed (no matter its size).
                 - If "same", the channels axis will be kept as is (if it exists).
+                - If "singleton", the channels axis will be set to size 1.
                 - If an integer is provided, the channels axis will be changed to have
                     that size.
             ngff_version (NgffVersions | None): The NGFF version to use.
@@ -267,8 +282,11 @@ class LabelsContainer:
 
         if name not in existing_labels:
             existing_labels.append(name)
-            self._group_handler.write_attrs({"labels": existing_labels})
 
+        update_meta = NgioLabelsGroupMeta(
+            labels=existing_labels, version=self.meta.version
+        )
+        self._meta_handler.update_meta(update_meta)
         return self.get(name)
 
 
@@ -282,7 +300,7 @@ def derive_label(
     z_spacing: float | None = None,
     time_spacing: float | None = None,
     name: str | None = None,
-    channels_policy: Literal["same", "squeeze"] | int = "squeeze",
+    channels_policy: Literal["same", "squeeze", "singleton"] | int = "squeeze",
     ngff_version: NgffVersions | None = None,
     # Zarr Array parameters
     chunks: ChunksLike = "auto",
@@ -308,9 +326,11 @@ def derive_label(
         z_spacing (float | None): The z spacing of the new label.
         time_spacing (float | None): The time spacing of the new label.
         name (str | None): The name of the new label.
-        channels_policy (Literal["squeeze", "same"] | int): Possible policies:
+        channels_policy (Literal["squeeze", "same", "singleton"] | int): Possible
+            policies:
             - If "squeeze", the channels axis will be removed (no matter its size).
             - If "same", the channels axis will be kept as is (if it exists).
+            - If "singleton", the channels axis will be set to size 1.
             - If an integer is provided, the channels axis will be changed to have that
                 size.
         ngff_version (NgffVersions | None): The NGFF version to use.

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/images/_ome_zarr_container.py

@@ -61,13 +61,13 @@ def _try_get_table_container(
 
 
 def _try_get_label_container(
-    handler: ZarrGroupHandler, create_mode: bool = True
+    handler: ZarrGroupHandler, ngff_version: NgffVersions, create_mode: bool = True
 ) -> LabelsContainer | None:
     """Return a default label container."""
     try:
         label_handler = handler.get_handler("labels", create_mode=create_mode)
-        return LabelsContainer(label_handler)
-    except NgioError:
+        return LabelsContainer(label_handler, ngff_version=ngff_version)
+    except FileNotFoundError:
         return None
 
 
@@ -149,7 +149,9 @@ class OmeZarrContainer:
             return self._labels_container
 
         _labels_container = _try_get_label_container(
-            self._group_handler, create_mode=create_mode
+            self._group_handler,
+            create_mode=create_mode,
+            ngff_version=self.image_meta.version,
         )
         self._labels_container = _labels_container
         return self._labels_container
@@ -428,6 +430,7 @@ class OmeZarrContainer:
         z_spacing: float | None = None,
         time_spacing: float | None = None,
         name: str | None = None,
+        channels_policy: Literal["squeeze", "same", "singleton"] | int = "same",
         channels_meta: Sequence[str | Channel] | None = None,
         ngff_version: NgffVersions | None = None,
         # Zarr Array parameters
@@ -459,6 +462,12 @@ class OmeZarrContainer:
             z_spacing (float | None): The z spacing of the new image.
             time_spacing (float | None): The time spacing of the new image.
             name (str | None): The name of the new image.
+            channels_policy (Literal["squeeze", "same"] | int): Possible policies:
+                - If "squeeze", the channels axis will be removed (no matter its size).
+                - If "same", the channels axis will be kept as is (if it exists).
+                - If "singleton", the channels axis will be set to size 1.
+                - If an integer is provided, the channels axis will be changed to have
+                    that size.
             channels_meta (Sequence[str | Channel] | None): The channels metadata
                 of the new image.
             ngff_version (NgffVersions | None): The NGFF version to use.
@@ -739,7 +748,7 @@ class OmeZarrContainer:
         pixelsize: float | tuple[float, float] | None = None,
         z_spacing: float | None = None,
         time_spacing: float | None = None,
-        channels_policy: Literal["same", "squeeze"] | int = "squeeze",
+        channels_policy: Literal["same", "squeeze", "singleton"] | int = "squeeze",
         ngff_version: NgffVersions | None = None,
         # Zarr Array parameters
         chunks: ChunksLike = "auto",
@@ -769,6 +778,7 @@ class OmeZarrContainer:
             channels_policy (Literal["same", "squeeze"] | int): Possible policies:
                 - If "squeeze", the channels axis will be removed (no matter its size).
                 - If "same", the channels axis will be kept as is (if it exists).
+                - If "singleton", the channels axis will be set to size 1.
                 - If an integer is provided, the channels axis will be changed to have
                     that size.
                 Defaults to "squeeze".

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/ome_zarr_meta/__init__.py

@@ -3,10 +3,12 @@
 from ngio.ome_zarr_meta._meta_handlers import (
     ImageMetaHandler,
     LabelMetaHandler,
+    LabelsGroupMetaHandler,
     PlateMetaHandler,
     WellMetaHandler,
     update_ngio_image_meta,
     update_ngio_label_meta,
+    update_ngio_labels_group_meta,
     update_ngio_meta,
     update_ngio_plate_meta,
     update_ngio_well_meta,
@@ -18,6 +20,7 @@ from ngio.ome_zarr_meta.ngio_specs import (
     NgffVersions,
     NgioImageMeta,
     NgioLabelMeta,
+    NgioLabelsGroupMeta,
     NgioPlateMeta,
     NgioWellMeta,
     PixelSize,
@@ -31,10 +34,12 @@ __all__ = [
     "ImageInWellPath",
     "ImageMetaHandler",
     "LabelMetaHandler",
+    "LabelsGroupMetaHandler",
     "NgffVersions",
     "NgffVersions",
     "NgioImageMeta",
     "NgioLabelMeta",
+    "NgioLabelsGroupMeta",
     "NgioPlateMeta",
     "NgioWellMeta",
     "PixelSize",
@@ -45,6 +50,7 @@ __all__ = [
     "path_in_well_validation",
     "update_ngio_image_meta",
     "update_ngio_label_meta",
+    "update_ngio_labels_group_meta",
     "update_ngio_meta",
     "update_ngio_plate_meta",
     "update_ngio_well_meta",

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/ome_zarr_meta/_meta_handlers.py

@@ -7,26 +7,32 @@ from ngio.ome_zarr_meta.ngio_specs import (
     AxesSetup,
     NgioImageMeta,
     NgioLabelMeta,
+    NgioLabelsGroupMeta,
     NgioPlateMeta,
     NgioWellMeta,
 )
+from ngio.ome_zarr_meta.ngio_specs._ngio_image import NgffVersions
 from ngio.ome_zarr_meta.v04 import (
     ngio_to_v04_image_meta,
     ngio_to_v04_label_meta,
+    ngio_to_v04_labels_group_meta,
     ngio_to_v04_plate_meta,
     ngio_to_v04_well_meta,
     v04_to_ngio_image_meta,
     v04_to_ngio_label_meta,
+    v04_to_ngio_labels_group_meta,
     v04_to_ngio_plate_meta,
     v04_to_ngio_well_meta,
 )
 from ngio.ome_zarr_meta.v05 import (
     ngio_to_v05_image_meta,
     ngio_to_v05_label_meta,
+    ngio_to_v05_labels_group_meta,
     ngio_to_v05_plate_meta,
     ngio_to_v05_well_meta,
     v05_to_ngio_image_meta,
     v05_to_ngio_label_meta,
+    v05_to_ngio_labels_group_meta,
     v05_to_ngio_plate_meta,
     v05_to_ngio_well_meta,
 )
@@ -45,9 +51,22 @@ _plate_encoder_registry = {"0.4": ngio_to_v04_plate_meta, "0.5": ngio_to_v05_pla
 _plate_decoder_registry = {"0.4": v04_to_ngio_plate_meta, "0.5": v05_to_ngio_plate_meta}
 _well_encoder_registry = {"0.4": ngio_to_v04_well_meta, "0.5": ngio_to_v05_well_meta}
 _well_decoder_registry = {"0.4": v04_to_ngio_well_meta, "0.5": v05_to_ngio_well_meta}
+_labels_group_encoder_registry = {
+    "0.4": ngio_to_v04_labels_group_meta,
+    "0.5": ngio_to_v05_labels_group_meta,
+}
+_labels_group_decoder_registry = {
+    "0.4": v04_to_ngio_labels_group_meta,
+    "0.5": v05_to_ngio_labels_group_meta,
+}
 
 _meta_type = TypeVar(
-    "_meta_type", NgioImageMeta, NgioLabelMeta, NgioPlateMeta, NgioWellMeta
+    "_meta_type",
+    NgioImageMeta,
+    NgioLabelMeta,
+    NgioLabelsGroupMeta,
+    NgioPlateMeta,
+    NgioWellMeta,
 )
 
 
@@ -62,6 +81,8 @@ def _find_encoder_registry(
         return _plate_encoder_registry
     elif isinstance(ngio_meta, NgioWellMeta):
         return _well_encoder_registry
+    elif isinstance(ngio_meta, NgioLabelsGroupMeta):
+        return _labels_group_encoder_registry
     else:
         raise NgioValueError(f"Unsupported NGIO metadata type: {type(ngio_meta)}")
 
@@ -97,6 +118,8 @@ def _find_decoder_registry(
         return _plate_decoder_registry
     elif meta_type is NgioWellMeta:
         return _well_decoder_registry
+    elif meta_type is NgioLabelsGroupMeta:
+        return _labels_group_decoder_registry
     else:
         raise NgioValueError(f"Unsupported NGIO metadata type: {meta_type}")
 
@@ -447,3 +470,67 @@ class WellMetaHandler:
             group_handler=self._group_handler,
             ngio_meta=ngio_meta,
         )
+
+
+def get_ngio_labels_group_meta(
+    group_handler: ZarrGroupHandler,
+    version: str | None = None,
+) -> NgioLabelsGroupMeta:
+    """Retrieve the NGIO labels group metadata from the Zarr group.
+
+    Args:
+        group_handler (ZarrGroupHandler): The Zarr group handler.
+        version (str | None): Optional NGFF version to use for decoding.
+
+    Returns:
+        NgioLabelsGroupMeta: The NGIO labels group metadata.
+    """
+    return get_ngio_meta(
+        group_handler=group_handler,
+        meta_type=NgioLabelsGroupMeta,
+        version=version,
+    )
+
+
+def update_ngio_labels_group_meta(
+    group_handler: ZarrGroupHandler,
+    ngio_meta: NgioLabelsGroupMeta,
+) -> None:
+    """Update the NGIO labels group metadata in the Zarr group.
+
+    Args:
+        group_handler (ZarrGroupHandler): The Zarr group handler.
+        ngio_meta (NgioLabelsGroupMeta): The new NGIO labels group metadata.
+
+    """
+    update_ngio_meta(
+        group_handler=group_handler,
+        ngio_meta=ngio_meta,
+    )
+
+
+class LabelsGroupMetaHandler:
+    def __init__(
+        self,
+        group_handler: ZarrGroupHandler,
+        version: NgffVersions | None = None,
+    ):
+        self._group_handler = group_handler
+        self._version = version
+
+        meta = self.get_meta()
+        self._version = meta.version
+
+    def get_meta(self) -> NgioLabelsGroupMeta:
+        """Retrieve the NGIO labels group metadata."""
+        return get_ngio_labels_group_meta(
+            group_handler=self._group_handler,
+            version=self._version,
+        )
+
+    def update_meta(self, ngio_meta: NgioLabelsGroupMeta) -> None:
+        """Update the NGIO labels group metadata."""
+        update_ngio_labels_group_meta(
+            group_handler=self._group_handler,
+            ngio_meta=ngio_meta,
+        )

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/ome_zarr_meta/ngio_specs/__init__.py

@@ -40,6 +40,7 @@ from ngio.ome_zarr_meta.ngio_specs._ngio_image import (
     NgioImageLabelMeta,
     NgioImageMeta,
     NgioLabelMeta,
+    NgioLabelsGroupMeta,
 )
 from ngio.ome_zarr_meta.ngio_specs._pixel_size import PixelSize
 
@@ -62,6 +63,7 @@ __all__ = [
     "NgioImageLabelMeta",
     "NgioImageMeta",
     "NgioLabelMeta",
+    "NgioLabelsGroupMeta",
     "NgioPlateMeta",
     "NgioWellMeta",
     "PixelSize",

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/ome_zarr_meta/ngio_specs/_ngio_image.py

@@ -41,6 +41,13 @@ class ImageLabelSource(BaseModel):
         return cls(version=version, source={"image": "../../"})
 
 
+class NgioLabelsGroupMeta(BaseModel):
+    """Metadata model for the /labels group in OME-NGFF."""
+
+    version: NgffVersions
+    labels: list[str]
+
+
 class AbstractNgioImageMeta:
     """Base class for ImageMeta and LabelMeta."""
 

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/ome_zarr_meta/v04/__init__.py

@@ -3,10 +3,12 @@
 from ngio.ome_zarr_meta.v04._v04_spec import (
     ngio_to_v04_image_meta,
     ngio_to_v04_label_meta,
+    ngio_to_v04_labels_group_meta,
     ngio_to_v04_plate_meta,
     ngio_to_v04_well_meta,
     v04_to_ngio_image_meta,
     v04_to_ngio_label_meta,
+    v04_to_ngio_labels_group_meta,
     v04_to_ngio_plate_meta,
     v04_to_ngio_well_meta,
 )
@@ -14,10 +16,12 @@ from ngio.ome_zarr_meta.v04._v04_spec import (
 __all__ = [
     "ngio_to_v04_image_meta",
     "ngio_to_v04_label_meta",
+    "ngio_to_v04_labels_group_meta",
     "ngio_to_v04_plate_meta",
     "ngio_to_v04_well_meta",
     "v04_to_ngio_image_meta",
     "v04_to_ngio_label_meta",
+    "v04_to_ngio_labels_group_meta",
     "v04_to_ngio_plate_meta",
     "v04_to_ngio_well_meta",
 ]

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/ome_zarr_meta/v04/_v04_spec.py

@@ -16,7 +16,8 @@ from ome_zarr_models.v04.coordinate_transformations import (
 )
 from ome_zarr_models.v04.hcs import HCSAttrs as HCSAttrsV04
 from ome_zarr_models.v04.image import ImageAttrs as ImageAttrsV04
-from ome_zarr_models.v04.image_label import ImageLabelAttrs as LabelAttrsV04
+from ome_zarr_models.v04.image_label import ImageLabelAttrs as ImageLabelAttrsV04
+from ome_zarr_models.v04.labels import LabelsAttrs as LabelsAttrsV04
 from ome_zarr_models.v04.multiscales import Dataset as DatasetV04
 from ome_zarr_models.v04.multiscales import Multiscale as MultiscaleV04
 from ome_zarr_models.v04.multiscales import ValidTransform as ValidTransformV04
@@ -36,6 +37,7 @@ from ngio.ome_zarr_meta.ngio_specs import (
     ImageLabelSource,
     NgioImageMeta,
     NgioLabelMeta,
+    NgioLabelsGroupMeta,
     NgioPlateMeta,
     NgioWellMeta,
     default_channel_name,
@@ -231,7 +233,7 @@ def v04_to_ngio_label_meta(
     Returns:
         NgioImageMeta: The ngio image metadata.
     """
-    v04_label = LabelAttrsV04(**metadata)
+    v04_label = ImageLabelAttrsV04(**metadata)
 
     if len(v04_label.multiscales) > 1:
         raise NotImplementedError(
@@ -381,10 +383,26 @@ def ngio_to_v04_label_meta(metadata: NgioLabelMeta) -> dict:
         "multiscales": [v04_muliscale],
         "image-label": metadata.image_label.model_dump(),
     }
-    v04_label = LabelAttrsV04(**labels_meta)
+    v04_label = ImageLabelAttrsV04(**labels_meta)
     return v04_label.model_dump(exclude_none=True, by_alias=True)
 
 
+def v04_to_ngio_labels_group_meta(
+    metadata: dict,
+) -> NgioLabelsGroupMeta:
+    """Convert a v04 label group metadata to a ngio label group metadata.
+
+    Args:
+        metadata (dict): The v04 label group metadata.
+
+    Returns:
+        NgioLabelGroupMeta: The ngio label group metadata.
+    """
+    v04_label_group = LabelsAttrsV04(**metadata).model_dump()
+    labels = v04_label_group.get("labels", [])
+    return NgioLabelsGroupMeta(labels=labels, version="0.4")
+
+
 def v04_to_ngio_well_meta(
     metadata: dict,
 ) -> NgioWellMeta:
@@ -440,3 +458,16 @@ def ngio_to_v04_plate_meta(metadata: NgioPlateMeta) -> dict:
     """
     v04_plate = HCSAttrsV04(**metadata.model_dump())
     return v04_plate.model_dump(exclude_none=True, by_alias=True)
+
+
+def ngio_to_v04_labels_group_meta(metadata: NgioLabelsGroupMeta) -> dict:
+    """Convert a ngio label group metadata to a v04 label group metadata.
+
+    Args:
+        metadata (NgioLabelsGroupMeta): The ngio label group metadata.
+
+    Returns:
+        dict: The v04 label group metadata.
+    """
+    v04_label_group = LabelsAttrsV04(labels=metadata.labels)
+    return v04_label_group.model_dump(exclude_none=True, by_alias=True)

{ngio-0.5.0a3 → ngio-0.5.0b1}/src/ngio/ome_zarr_meta/v05/__init__.py

@@ -3,10 +3,12 @@
 from ngio.ome_zarr_meta.v05._v05_spec import (
     ngio_to_v05_image_meta,
     ngio_to_v05_label_meta,
+    ngio_to_v05_labels_group_meta,
     ngio_to_v05_plate_meta,
     ngio_to_v05_well_meta,
     v05_to_ngio_image_meta,
     v05_to_ngio_label_meta,
+    v05_to_ngio_labels_group_meta,
     v05_to_ngio_plate_meta,
     v05_to_ngio_well_meta,
 )
@@ -14,10 +16,12 @@ from ngio.ome_zarr_meta.v05._v05_spec import (
 __all__ = [
     "ngio_to_v05_image_meta",
     "ngio_to_v05_label_meta",
+    "ngio_to_v05_labels_group_meta",
     "ngio_to_v05_plate_meta",
     "ngio_to_v05_well_meta",
     "v05_to_ngio_image_meta",
     "v05_to_ngio_label_meta",
+    "v05_to_ngio_labels_group_meta",
     "v05_to_ngio_plate_meta",
     "v05_to_ngio_well_meta",
 ]