ngio 0.1.6__py3-none-any.whl → 0.2.0__py3-none-any.whl

ngio/images/ome_zarr_container.py

@@ -0,0 +1,738 @@
+"""Abstract class for handling OME-NGFF images."""
+
+from collections.abc import Collection
+from typing import Literal, overload
+
+import numpy as np
+
+from ngio.images.create import _create_empty_image
+from ngio.images.image import Image, ImagesContainer
+from ngio.images.label import Label, LabelsContainer
+from ngio.images.masked_image import MaskedImage, MaskedLabel
+from ngio.ome_zarr_meta import (
+    NgioImageMeta,
+    PixelSize,
+)
+from ngio.ome_zarr_meta.ngio_specs import (
+    SpaceUnits,
+    TimeUnits,
+)
+from ngio.tables import (
+    FeatureTable,
+    GenericRoiTable,
+    MaskingRoiTable,
+    RoiTable,
+    Table,
+    TablesContainer,
+    TypedTable,
+)
+from ngio.utils import (
+    AccessModeLiteral,
+    NgioValidationError,
+    NgioValueError,
+    StoreOrGroup,
+    ZarrGroupHandler,
+)
+
+
+def _default_table_container(handler: ZarrGroupHandler) -> TablesContainer | None:
+    """Return a default table container."""
+    success, table_handler = handler.safe_derive_handler("tables")
+    if success and isinstance(table_handler, ZarrGroupHandler):
+        return TablesContainer(table_handler)
+
+
+def _default_label_container(handler: ZarrGroupHandler) -> LabelsContainer | None:
+    """Return a default label container."""
+    success, label_handler = handler.safe_derive_handler("labels")
+    if success and isinstance(label_handler, ZarrGroupHandler):
+        return LabelsContainer(label_handler)
+
+
+class OmeZarrContainer:
+    """This class contains an OME-Zarr image and its associated tables and labels."""
+
+    _images_container: ImagesContainer
+    _labels_container: LabelsContainer | None
+    _tables_container: TablesContainer | None
+
+    def __init__(
+        self,
+        group_handler: ZarrGroupHandler,
+        table_container: TablesContainer | None = None,
+        label_container: LabelsContainer | None = None,
+        validate_arrays: bool = True,
+    ) -> None:
+        """Initialize the OmeZarrContainer."""
+        self._group_handler = group_handler
+        self._images_container = ImagesContainer(self._group_handler)
+
+        self._labels_container = label_container
+        self._tables_container = table_container
+
+    def __repr__(self) -> str:
+        """Return a string representation of the image."""
+        num_labels = len(self.list_labels())
+        num_tables = len(self.list_tables())
+
+        base_str = f"OmeZarrContainer(levels={self.levels}"
+        if num_labels > 0 and num_labels < 3:
+            base_str += f", labels={self.list_labels()}"
+        elif num_labels >= 3:
+            base_str += f", #labels={num_labels}"
+        if num_tables > 0 and num_tables < 3:
+            base_str += f", tables={self.list_tables()}"
+        elif num_tables >= 3:
+            base_str += f", #tables={num_tables}"
+        base_str += ")"
+        return base_str
+
+    @property
+    def images_container(self) -> ImagesContainer:
+        """Return the image container."""
+        return self._images_container
+
+    @property
+    def labels_container(self) -> LabelsContainer:
+        """Return the labels container."""
+        if self._labels_container is None:
+            self._labels_container = _default_label_container(self._group_handler)
+            if self._labels_container is None:
+                raise NgioValidationError("No labels found in the image.")
+        return self._labels_container
+
+    @property
+    def tables_container(self) -> TablesContainer:
+        """Return the tables container."""
+        if self._tables_container is None:
+            self._tables_container = _default_table_container(self._group_handler)
+            if self._tables_container is None:
+                raise NgioValidationError("No tables found in the image.")
+        return self._tables_container
+
+    @property
+    def image_meta(self) -> NgioImageMeta:
+        """Return the image metadata."""
+        return self._images_container.meta
+
+    @property
+    def levels(self) -> int:
+        """Return the number of levels in the image."""
+        return self._images_container.levels
+
+    @property
+    def levels_paths(self) -> list[str]:
+        """Return the paths of the levels in the image."""
+        return self._images_container.levels_paths
+
+    @property
+    def is_3d(self) -> bool:
+        """Return True if the image is 3D."""
+        return self.get_image().is_3d
+
+    @property
+    def is_2d(self) -> bool:
+        """Return True if the image is 2D."""
+        return self.get_image().is_2d
+
+    @property
+    def is_time_series(self) -> bool:
+        """Return True if the image is a time series."""
+        return self.get_image().is_time_series
+
+    @property
+    def is_2d_time_series(self) -> bool:
+        """Return True if the image is a 2D time series."""
+        return self.get_image().is_2d_time_series
+
+    @property
+    def is_3d_time_series(self) -> bool:
+        """Return True if the image is a 3D time series."""
+        return self.get_image().is_3d_time_series
+
+    @property
+    def is_multi_channels(self) -> bool:
+        """Return True if the image is multichannel."""
+        return self.get_image().is_multi_channels
+
+    def initialize_channel_meta(
+        self,
+        labels: Collection[str] | int | None = None,
+        wavelength_id: Collection[str] | None = None,
+        percentiles: tuple[float, float] | None = None,
+        colors: Collection[str] | None = None,
+        active: Collection[bool] | None = None,
+        **omero_kwargs: dict,
+    ) -> None:
+        """Create a ChannelsMeta object with the default unit."""
+        self._images_container.initialize_channel_meta(
+            labels=labels,
+            wavelength_id=wavelength_id,
+            percentiles=percentiles,
+            colors=colors,
+            active=active,
+            **omero_kwargs,
+        )
+
+    def update_percentiles(
+        self,
+        start_percentile: float = 0.1,
+        end_percentile: float = 99.9,
+    ) -> None:
+        """Update the percentiles of the image."""
+        self._images_container.update_percentiles(
+            start_percentile=start_percentile, end_percentile=end_percentile
+        )
+
+    def get_image(
+        self,
+        path: str | None = None,
+        pixel_size: PixelSize | None = None,
+        strict: bool = False,
+    ) -> Image:
+        """Get an image at a specific level.
+
+        Args:
+            path (str | None): The path to the image in the ome_zarr file.
+            pixel_size (PixelSize | None): The pixel size of the image.
+            strict (bool): Only used if the pixel size is provided. If True, the
+                pixel size must match the image pixel size exactly. If False, the
+                closest pixel size level will be returned.
+
+        """
+        return self._images_container.get(
+            path=path, pixel_size=pixel_size, strict=strict
+        )
+
+    def get_masked_image(
+        self,
+        masking_label_name: str,
+        masking_table_name: str | None = None,
+        path: str | None = None,
+        pixel_size: PixelSize | None = None,
+        strict: bool = False,
+    ) -> MaskedImage:
+        """Get a masked image at a specific level.
+
+        Args:
+            masking_label_name (str): The name of the label.
+            masking_table_name (str | None): The name of the masking table.
+            path (str | None): The path to the image in the ome_zarr file.
+            pixel_size (PixelSize | None): The pixel size of the image.
+            strict (bool): Only used if the pixel size is provided. If True, the
+                pixel size must match the image pixel size exactly. If False, the
+                closest pixel size level will be returned.
+        """
+        image = self.get_image(path=path, pixel_size=pixel_size, strict=strict)
+        masking_label = self.get_label(
+            name=masking_label_name, path=path, pixel_size=pixel_size, strict=strict
+        )
+        if masking_table_name is None:
+            masking_table = masking_label.build_masking_roi_table()
+        else:
+            masking_table = self.get_table(
+                masking_table_name, check_type="masking_roi_table"
+            )
+
+        return MaskedImage(
+            group_handler=image._group_handler,
+            path=masking_label.path,
+            meta_handler=image.meta_handler,
+            label=masking_label,
+            masking_roi_table=masking_table,
+        )
+
+    def derive_image(
+        self,
+        store: StoreOrGroup,
+        ref_path: str | None = None,
+        shape: Collection[int] | None = None,
+        labels: Collection[str] | None = None,
+        pixel_size: PixelSize | None = None,
+        axes_names: Collection[str] | None = None,
+        chunks: Collection[int] | None = None,
+        dtype: str | None = None,
+        copy_labels: bool = False,
+        copy_tables: bool = False,
+        overwrite: bool = False,
+    ) -> "OmeZarrContainer":
+        """Create an empty OME-Zarr container from an existing image.
+
+        Args:
+            store (StoreOrGroup): The Zarr store or group to create the image in.
+            ref_path (str | None): The path to the reference image in
+                the image container.
+            shape (Collection[int] | None): The shape of the new image.
+            labels (Collection[str] | None): The labels of the new image.
+            pixel_size (PixelSize | None): The pixel size of the new image.
+            axes_names (Collection[str] | None): The axes names of the new image.
+            chunks (Collection[int] | None): The chunk shape of the new image.
+            dtype (str | None): The data type of the new image.
+            copy_labels (bool): Whether to copy the labels from the reference image.
+            copy_tables (bool): Whether to copy the tables from the reference image.
+            overwrite (bool): Whether to overwrite an existing image.
+
+        Returns:
+            OmeZarrContainer: The new image container.
+
+        """
+        _ = self._images_container.derive(
+            store=store,
+            ref_path=ref_path,
+            shape=shape,
+            labels=labels,
+            pixel_size=pixel_size,
+            axes_names=axes_names,
+            chunks=chunks,
+            dtype=dtype,
+            overwrite=overwrite,
+        )
+
+        handler = ZarrGroupHandler(
+            store, cache=self._group_handler.use_cache, mode=self._group_handler.mode
+        )
+
+        new_ome_zarr = OmeZarrContainer(
+            group_handler=handler,
+            validate_arrays=False,
+        )
+
+        if copy_labels:
+            self.labels_container._group_handler.copy_handler(
+                new_ome_zarr.labels_container._group_handler
+            )
+
+        if copy_tables:
+            self.tables_container._group_handler.copy_handler(
+                new_ome_zarr.tables_container._group_handler
+            )
+        return new_ome_zarr
+
+    def list_tables(self) -> list[str]:
+        """List all tables in the image."""
+        return self.tables_container.list()
+
+    def list_roi_tables(self) -> list[str]:
+        """List all ROI tables in the image."""
+        return self.tables_container.list_roi_tables()
+
+    @overload
+    def get_table(self, name: str, check_type: None) -> Table: ...
+
+    @overload
+    def get_table(self, name: str, check_type: Literal["roi_table"]) -> RoiTable: ...
+
+    @overload
+    def get_table(
+        self, name: str, check_type: Literal["masking_roi_table"]
+    ) -> MaskingRoiTable: ...
+
+    @overload
+    def get_table(
+        self, name: str, check_type: Literal["feature_table"]
+    ) -> FeatureTable: ...
+
+    @overload
+    def get_table(
+        self, name: str, check_type: Literal["generic_roi_table"]
+    ) -> GenericRoiTable: ...
+
+    def get_table(self, name: str, check_type: TypedTable | None = None) -> Table:
+        """Get a table from the image."""
+        table = self.tables_container.get(name)
+        match check_type:
+            case "roi_table":
+                if not isinstance(table, RoiTable):
+                    raise NgioValueError(
+                        f"Table '{name}' is not a ROI table. Found type: {table.type()}"
+                    )
+                return table
+            case "masking_roi_table":
+                if not isinstance(table, MaskingRoiTable):
+                    raise NgioValueError(
+                        f"Table '{name}' is not a masking ROI table. "
+                        f"Found type: {table.type()}"
+                    )
+                return table
+
+            case "generic_roi_table":
+                if not isinstance(table, GenericRoiTable):
+                    raise NgioValueError(
+                        f"Table '{name}' is not a generic ROI table. "
+                        f"Found type: {table.type()}"
+                    )
+                return table
+
+            case "feature_table":
+                if not isinstance(table, FeatureTable):
+                    raise NgioValueError(
+                        f"Table '{name}' is not a feature table. "
+                        f"Found type: {table.type()}"
+                    )
+                return table
+            case None:
+                return table
+            case _:
+                raise NgioValueError(f"Unknown check_type: {check_type}")
+
+    def build_image_roi_table(self, name: str = "image") -> RoiTable:
+        """Compute the ROI table for an image."""
+        return self.get_image().build_image_roi_table(name=name)
+
+    def build_masking_roi_table(self, label: str) -> MaskingRoiTable:
+        """Compute the masking ROI table for a label."""
+        return self.get_label(label).build_masking_roi_table()
+
+    def add_table(
+        self,
+        name: str,
+        table: Table,
+        backend: str | None = None,
+        overwrite: bool = False,
+    ) -> None:
+        """Add a table to the image."""
+        self.tables_container.add(
+            name=name, table=table, backend=backend, overwrite=overwrite
+        )
+
+    def list_labels(self) -> list[str]:
+        """List all labels in the image."""
+        return self.labels_container.list()
+
+    def get_label(
+        self,
+        name: str,
+        path: str | None = None,
+        pixel_size: PixelSize | None = None,
+        strict: bool = False,
+    ) -> Label:
+        """Get a label from the group.
+
+        Args:
+            name (str): The name of the label.
+            path (str | None): The path to the image in the ome_zarr file.
+            pixel_size (PixelSize | None): The pixel size of the image.
+            strict (bool): Only used if the pixel size is provided. If True, the
+                pixel size must match the image pixel size exactly. If False, the
+                closest pixel size level will be returned.
+        """
+        return self.labels_container.get(
+            name=name, path=path, pixel_size=pixel_size, strict=strict
+        )
+
+    def get_masked_label(
+        self,
+        label_name: str,
+        masking_label_name: str,
+        masking_table_name: str | None = None,
+        path: str | None = None,
+        pixel_size: PixelSize | None = None,
+        strict: bool = False,
+    ) -> MaskedLabel:
+        """Get a masked image at a specific level.
+
+        Args:
+            label_name (str): The name of the label.
+            masking_label_name (str): The name of the masking label.
+            masking_table_name (str | None): The name of the masking table.
+            path (str | None): The path to the image in the ome_zarr file.
+            pixel_size (PixelSize | None): The pixel size of the image.
+            strict (bool): Only used if the pixel size is provided. If True, the
+                pixel size must match the image pixel size exactly. If False, the
+                closest pixel size level will be returned.
+        """
+        label = self.get_label(
+            name=label_name, path=path, pixel_size=pixel_size, strict=strict
+        )
+        masking_label = self.get_label(
+            name=masking_label_name, path=path, pixel_size=pixel_size, strict=strict
+        )
+        if masking_table_name is None:
+            masking_table = masking_label.build_masking_roi_table()
+        else:
+            masking_table = self.get_table(
+                masking_table_name, check_type="masking_roi_table"
+            )
+
+        return MaskedLabel(
+            group_handler=label._group_handler,
+            path=label.path,
+            meta_handler=label.meta_handler,
+            label=masking_label,
+            masking_roi_table=masking_table,
+        )
+
+    def derive_label(
+        self,
+        name: str,
+        ref_image: Image | None = None,
+        shape: Collection[int] | None = None,
+        pixel_size: PixelSize | None = None,
+        axes_names: Collection[str] | None = None,
+        chunks: Collection[int] | None = None,
+        dtype: str | None = None,
+        overwrite: bool = False,
+    ) -> "Label":
+        """Create an empty OME-Zarr label from a reference image.
+
+        And add the label to the /labels group.
+
+        Args:
+            store (StoreOrGroup): The Zarr store or group to create the image in.
+            ref_image (Image): The reference image.
+            name (str): The name of the new image.
+            shape (Collection[int] | None): The shape of the new image.
+            pixel_size (PixelSize | None): The pixel size of the new image.
+            axes_names (Collection[str] | None): The axes names of the new image.
+                For labels, the channel axis is not allowed.
+            chunks (Collection[int] | None): The chunk shape of the new image.
+            dtype (str | None): The data type of the new image.
+            overwrite (bool): Whether to overwrite an existing image.
+
+        Returns:
+            Label: The new label.
+
+        """
+        if ref_image is None:
+            ref_image = self.get_image()
+        return self.labels_container.derive(
+            name=name,
+            ref_image=ref_image,
+            shape=shape,
+            pixel_size=pixel_size,
+            axes_names=axes_names,
+            chunks=chunks,
+            dtype=dtype,
+            overwrite=overwrite,
+        )
+
+
+def open_ome_zarr_container(
+    store: StoreOrGroup,
+    cache: bool = False,
+    mode: AccessModeLiteral = "r+",
+    validate_arrays: bool = True,
+) -> OmeZarrContainer:
+    """Open an OME-Zarr image."""
+    handler = ZarrGroupHandler(store=store, cache=cache, mode=mode)
+    return OmeZarrContainer(
+        group_handler=handler,
+        validate_arrays=validate_arrays,
+    )
+
+
+def open_image(
+    store: StoreOrGroup,
+    path: str | None = None,
+    pixel_size: PixelSize | None = None,
+    strict: bool = True,
+    cache: bool = False,
+    mode: AccessModeLiteral = "r+",
+) -> Image:
+    """Open a single level image from an OME-Zarr image.
+
+    Args:
+        store (StoreOrGroup): The Zarr store or group to create the image in.
+        path (str | None): The path to the image in the ome_zarr file.
+        pixel_size (PixelSize | None): The pixel size of the image.
+        strict (bool): Only used if the pixel size is provided. If True, the
+                pixel size must match the image pixel size exactly. If False, the
+                closest pixel size level will be returned.
+        cache (bool): Whether to use a cache for the zarr group metadata.
+        mode (AccessModeLiteral): The
+            access mode for the image. Defaults to "r+".
+    """
+    group_handler = ZarrGroupHandler(store, cache, mode)
+    images_container = ImagesContainer(group_handler)
+    return images_container.get(
+        path=path,
+        pixel_size=pixel_size,
+        strict=strict,
+    )
+
+
+def create_empty_ome_zarr(
+    store: StoreOrGroup,
+    shape: Collection[int],
+    xy_pixelsize: float,
+    z_spacing: float = 1.0,
+    time_spacing: float = 1.0,
+    levels: int | list[str] = 5,
+    xy_scaling_factor: float = 2,
+    z_scaling_factor: float = 1.0,
+    space_unit: SpaceUnits | str | None = None,
+    time_unit: TimeUnits | str | None = None,
+    axes_names: Collection[str] | None = None,
+    name: str | None = None,
+    chunks: Collection[int] | None = None,
+    dtype: str = "uint16",
+    channel_labels: list[str] | None = None,
+    channel_wavelengths: list[str] | None = None,
+    percentiles: tuple[float, float] | None = None,
+    channel_colors: Collection[str] | None = None,
+    channel_active: Collection[bool] | None = None,
+    overwrite: bool = False,
+    version: str = "0.4",
+) -> OmeZarrContainer:
+    """Create an empty OME-Zarr image with the given shape and metadata.
+
+    Args:
+        store (StoreOrGroup): The Zarr store or group to create the image in.
+        shape (Collection[int]): The shape of the image.
+        xy_pixelsize (float): The pixel size in x and y dimensions.
+        z_spacing (float, optional): The spacing between z slices. Defaults to 1.0.
+        time_spacing (float, optional): The spacing between time points.
+            Defaults to 1.0.
+        levels (int | list[str], optional): The number of levels in the pyramid or a
+            list of level names. Defaults to 5.
+        xy_scaling_factor (float, optional): The down-scaling factor in x and y
+            dimensions. Defaults to 2.0.
+        z_scaling_factor (float, optional): The down-scaling factor in z dimension.
+            Defaults to 1.0.
+        space_unit (SpaceUnits | str | None, optional): The unit of space. Defaults to
+            None.
+        time_unit (TimeUnits | str | None, optional): The unit of time. Defaults to
+            None.
+        axes_names (Collection[str] | None, optional): The names of the axes.
+            If None the canonical names are used. Defaults to None.
+        name (str | None, optional): The name of the image. Defaults to None.
+        chunks (Collection[int] | None, optional): The chunk shape. If None the shape
+            is used. Defaults to None.
+        dtype (str, optional): The data type of the image. Defaults to "uint16".
+        channel_labels (list[str] | None, optional): The labels of the channels.
+            Defaults to None.
+        channel_wavelengths (list[str] | None, optional): The wavelengths of the
+            channels. Defaults to None.
+        percentiles (tuple[float, float] | None, optional): The percentiles of the
+            channels. Defaults to None.
+        channel_colors (Collection[str] | None, optional): The colors of the channels.
+            Defaults to None.
+        channel_active (Collection[bool] | None, optional): Whether the channels are
+            active. Defaults to None.
+        overwrite (bool, optional): Whether to overwrite an existing image.
+            Defaults to True.
+        version (str, optional): The version of the OME-Zarr specification.
+            Defaults to "0.4".
+    """
+    handler = _create_empty_image(
+        store=store,
+        shape=shape,
+        pixelsize=xy_pixelsize,
+        z_spacing=z_spacing,
+        time_spacing=time_spacing,
+        levels=levels,
+        yx_scaling_factor=xy_scaling_factor,
+        z_scaling_factor=z_scaling_factor,
+        space_unit=space_unit,
+        time_unit=time_unit,
+        axes_names=axes_names,
+        name=name,
+        chunks=chunks,
+        dtype=dtype,
+        overwrite=overwrite,
+        version=version,
+    )
+
+    ome_zarr = OmeZarrContainer(group_handler=handler)
+    ome_zarr.initialize_channel_meta(
+        labels=channel_labels,
+        wavelength_id=channel_wavelengths,
+        percentiles=percentiles,
+        colors=channel_colors,
+        active=channel_active,
+    )
+    return ome_zarr
+
+
+def create_ome_zarr_from_array(
+    store: StoreOrGroup,
+    array: np.ndarray,
+    xy_pixelsize: float,
+    z_spacing: float = 1.0,
+    time_spacing: float = 1.0,
+    levels: int | list[str] = 5,
+    xy_scaling_factor: float = 2.0,
+    z_scaling_factor: float = 1.0,
+    space_unit: SpaceUnits | str | None = None,
+    time_unit: TimeUnits | str | None = None,
+    axes_names: Collection[str] | None = None,
+    channel_labels: list[str] | None = None,
+    channel_wavelengths: list[str] | None = None,
+    percentiles: tuple[float, float] | None = (0.1, 99.9),
+    channel_colors: Collection[str] | None = None,
+    channel_active: Collection[bool] | None = None,
+    name: str | None = None,
+    chunks: Collection[int] | None = None,
+    overwrite: bool = False,
+    version: str = "0.4",
+) -> OmeZarrContainer:
+    """Create an OME-Zarr image from a numpy array.
+
+    Args:
+        store (StoreOrGroup): The Zarr store or group to create the image in.
+        array (np.ndarray): The image data.
+        xy_pixelsize (float): The pixel size in x and y dimensions.
+        z_spacing (float, optional): The spacing between z slices. Defaults to 1.0.
+        time_spacing (float, optional): The spacing between time points.
+            Defaults to 1.0.
+        levels (int | list[str], optional): The number of levels in the pyramid or a
+            list of level names. Defaults to 5.
+        xy_scaling_factor (float, optional): The down-scaling factor in x and y
+            dimensions. Defaults to 2.0.
+        z_scaling_factor (float, optional): The down-scaling factor in z dimension.
+            Defaults to 1.0.
+        space_unit (SpaceUnits | str | None, optional): The unit of space. Defaults to
+            None.
+        time_unit (TimeUnits | str | None, optional): The unit of time. Defaults to
+            None.
+        axes_names (Collection[str] | None, optional): The names of the axes.
+            If None the canonical names are used. Defaults to None.
+        name (str | None, optional): The name of the image. Defaults to None.
+        chunks (Collection[int] | None, optional): The chunk shape. If None the shape
+            is used. Defaults to None.
+        channel_labels (list[str] | None, optional): The labels of the channels.
+            Defaults to None.
+        channel_wavelengths (list[str] | None, optional): The wavelengths of the
+            channels. Defaults to None.
+        percentiles (tuple[float, float] | None, optional): The percentiles of the
+            channels. Defaults to None.
+        channel_colors (Collection[str] | None, optional): The colors of the channels.
+            Defaults to None.
+        channel_active (Collection[bool] | None, optional): Whether the channels are
+            active. Defaults to None.
+        overwrite (bool, optional): Whether to overwrite an existing image.
+            Defaults to True.
+        version (str, optional): The version of the OME-Zarr specification.
+            Defaults to "0.4".
+    """
+    handler = _create_empty_image(
+        store=store,
+        shape=array.shape,
+        pixelsize=xy_pixelsize,
+        z_spacing=z_spacing,
+        time_spacing=time_spacing,
+        levels=levels,
+        yx_scaling_factor=xy_scaling_factor,
+        z_scaling_factor=z_scaling_factor,
+        space_unit=space_unit,
+        time_unit=time_unit,
+        axes_names=axes_names,
+        name=name,
+        chunks=chunks,
+        dtype=array.dtype,
+        overwrite=overwrite,
+        version=version,
+    )
+
+    ome_zarr = OmeZarrContainer(group_handler=handler)
+    image = ome_zarr.get_image()
+    image.set_array(array)
+    image.consolidate()
+    ome_zarr.initialize_channel_meta(
+        labels=channel_labels,
+        wavelength_id=channel_wavelengths,
+        percentiles=percentiles,
+        colors=channel_colors,
+        active=channel_active,
+    )
+    return ome_zarr