Format (`ome_zarr.format`)

Hierarchy of format OME-Zarr implementations.

ome_zarr.format.CurrentFormat: alias of FormatV05

class ome_zarr.format.Format[source]: Abstract base class for format implementations.

class ome_zarr.format.FormatV01[source]

Initial format. (2020)

init_store(path: str, mode: str = 'r') → FsspecStore | LocalStore[source]: Not ideal. Stores should remain hidden “dimension_separator” is specified at array creation time

class ome_zarr.format.FormatV02[source]: Changelog: move to nested storage (April 2021)

class ome_zarr.format.FormatV03[source]: Changelog: variable number of dimensions (up to 5), introduce axes field in multiscales (June 2021)

class ome_zarr.format.FormatV04[source]

Changelog: axes is list of dicts, introduce coordinate_transformations in multiscales (Nov 2021)

validate_coordinate_transformations(ndim: int, nlevels: int, coordinate_transformations: list[list[dict[str, Any]]] | None = None) → None[source]

Validates that a list of dicts contains a ‘scale’ transformation

Raises ValueError if no ‘scale’ found or doesn’t match ndim.

Parameters:: ndim – Number of image dimensions.

class ome_zarr.format.FormatV05[source]: Changelog: added FormatV05 (May 2025): writing not supported yet

ome_zarr.format.detect_format(metadata: dict, default: Format) → Format[source]: Give each format implementation a chance to take ownership of the given metadata. If none matches, the default value will be returned.

ome_zarr.format.format_implementations() → Iterator[Format][source]: Return an instance of each format implementation, newest to oldest.