ngff_zarr.axis_type

The axis types the specification names.

Module Contents

Classes

AxisType

An axis type the specification names.

API

class ngff_zarr.axis_type.AxisType

Bases: enum.StrEnum

An axis type the specification names.

RFC-3 (OME-Zarr 0.9.dev1) lets an axis carry any string, so this is the named set rather than the permitted one: an API that takes an axis type is annotated AxisType | str and accepts both. The members are the values themselves, so AxisType.Space == "space".

Displacement and Coordinate arrive with RFC-5 (OME-Zarr 0.6) and type the component axis of a field; the other three are in the format from 0.4 on. Mirrors the TypeScript port’s AxisType.

Initialization

Initialize self. See help(type(self)) for accurate signature.

Space

‘space’

Time

‘time’

Channel

‘channel’

Displacement

‘displacement’

Coordinate

‘coordinate’