Skip to content

Base objects

ome_zarr_models.base.BaseAttrs

Bases: BaseModel

The base pydantic model for all metadata classes

ome_zarr_models.base.BaseAttrsv2

Bases: BaseAttrs

Base attribute model for Zarr v2 groups (ie OME-Zarr 0.4).

get_array_paths

get_array_paths() -> list[str]

Get a list of all array paths expected and required to live in the Group with these attributes.

get_group_paths

get_group_paths() -> dict[str, type[AnyGroupSpec]]

Get a list of all group paths expected and required to live in the Group with these attributes.

Must return a dictionary mapping paths to their GroupSpec class.

get_optional_array_paths

get_optional_array_paths() -> list[str]

Get a list of all array paths expected but not required to live in the Group with these attributes.

get_optional_group_paths

get_optional_group_paths() -> dict[str, type[AnyGroupSpec]]

Get a list of all group paths expected but not required to live in the Group with these attributes.

Must return a dictionary mapping paths to their GroupSpec class.

ome_zarr_models.base.BaseAttrsv3

Bases: BaseAttrs

Base attribute model for Zarr v3 groups (ie OME-Zarr 0.5+).

get_array_paths

get_array_paths() -> list[str]

Get a list of all array paths expected and required to live in the Group with these attributes.

get_group_paths

get_group_paths() -> dict[str, type[AnyGroupSpec]]

Get a list of all group paths expected and required to live in the Group with these attributes.

Must return a dictionary mapping paths to their GroupSpec class.

get_optional_array_paths

get_optional_array_paths() -> list[str]

Get a list of all array paths expected but not required to live in the Group with these attributes.

get_optional_group_paths

get_optional_group_paths() -> dict[str, type[AnyGroupSpec]]

Get a list of all group paths expected but not required to live in the Group with these attributes.

Must return a dictionary mapping paths to their GroupSpec class.

ome_zarr_models.base.BaseGroup

Bases: ABC

Base class for all OME-Zarr groups.

ome_attributes

ome_attributes: BaseAttrs

OME attributes.

ome_zarr_version

ome_zarr_version: Literal['0.4', '0.5', '0.6']

Version of the OME-Zarr specification that this group corresponds to.