Well

Warning

The implementation of OME-Zarr 0.6 is not final, and subject to change. It is provided so users can test and evaluate ome-zarr-models and the specification before it becomes final. Please report issues and provide feedback!

ome_zarr_models.v06.well.Well

Bases: BaseGroupv06[WellAttrs]

An OME-Zarr well dataset.

Attributes:

Name	Type	Description
`zarr_format`	`Literal[3]`
`node_type`	`Literal['group']`
`attributes`	`BaseZarrAttrs[WellAttrs]`
`members`	`Mapping[str, GroupSpec \| ArraySpec] \| None`

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

ome_zarr_models.v06.well.WellAttrs

Bases: BaseOMEAttrs

Attributes for a well.

Attributes:

Name	Type	Description
`version`	`Literal['0.6.dev4']`
`well`	`WellMeta`

Other types

ome_zarr_models.v06.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.v06.well_types.WellMeta

Bases: WellMeta

Metadata for a single well.

Attributes:

Name	Type	Description
`images`	`list[WellImage]`	Images within a well
`version`	`Literal['0.6.dev4'] \| None`	Version of the well specification