Well

For reference, see the well section of the OME-Zarr specification.

ome_zarr_models.v04.well.Well

Bases: BaseGroupv04[WellAttrs]

An OME-Zarr well group.

Attributes:

Name	Type	Description
zarr_format	Literal[2]
attributes	WellAttrs
members	Mapping[str, GroupSpec | ArraySpec] | None

images

images: Generator[Image, None, None]

Generator for all images in this well.

n_images

n_images: int

Number of images.

from_zarr

from_zarr(group: Group) -> Self

Create an OME-Zarr well model from a zarr.Group.

Parameters:

Name	Type	Description	Default
group	Group	A Zarr group that has valid OME-Zarr well metadata.	required

get_image

get_image(i: int) -> Image

Get a single image from this well.

ome_zarr_models.v04.well.WellAttrs

Bases: BaseAttrsv2

Attributes for a well group.

Attributes:

Name	Type	Description
well	WellMeta

Other types

For reference, see the well section of the OME-Zarr specification.

ome_zarr_models.v04.well_types.WellImage

Bases: BaseAttrs

A single image within a well.

Attributes:

Name	Type	Description
path	str
acquisition	int | None	A unique identifier within the context of the plate

ome_zarr_models.v04.well_types.WellMeta

Bases: WellMeta

Metadata for a single well.

Attributes:

Name	Type	Description
images	list[WellImage]	Images within a well
version	Literal['0.4'] | None	Version of the well specification