Skip to article frontmatterSkip to article content

NGFF CoordinateSystem

Title: NGFF CoordinateSystem

Typearray
RequiredNo

Description: JSON from OME-NGFF .zattrs

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
coordinateSystemCoordinate Systems for OME-NGFF

1. NGFF CoordinateSystem > coordinateSystem

Typeobject
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/coordinateSystem

Description: Coordinate Systems for OME-NGFF

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-Name of coordinate system
+ axesNoarrayNoIn axes.schemaNGFF Axes

1.1. Property NGFF CoordinateSystem > root items > name

Typestring
RequiredYes

Description: Name of coordinate system

1.2. Property NGFF CoordinateSystem > root items > axes

Title: NGFF Axes

Typearray
RequiredYes
Defined inaxes.schema

Description: JSON from OME-NGFF .zattrs

Array restrictions
Min items1
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
axis-

1.2.1. NGFF CoordinateSystem > root items > axes > axis

Typeobject
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/axis
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-Name of the axis
- longNameNostringNo-Longer name or description of the axis.
- typeNostringNo-Dimension of the axis
- discreteNobooleanNo-Whether the dimension is discrete
- unitNostringNo-Unit for the axis
1.2.1.1. Property NGFF CoordinateSystem > root items > axes > axes items > name
Typestring
RequiredYes

Description: Name of the axis

1.2.1.2. Property NGFF CoordinateSystem > root items > axes > axes items > longName
Typestring
RequiredNo

Description: Longer name or description of the axis.

1.2.1.3. Property NGFF CoordinateSystem > root items > axes > axes items > type
Typestring
RequiredNo

Description: Dimension of the axis

1.2.1.4. Property NGFF CoordinateSystem > root items > axes > axes items > discrete
Typeboolean
RequiredNo

Description: Whether the dimension is discrete

1.2.1.5. Property NGFF CoordinateSystem > root items > axes > axes items > unit
Typestring
RequiredNo

Description: Unit for the axis

1.2.2. At least one of the items must be

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- nameNostringNo--
- typeNoenum (of string)No--
- unitNostringNo--
1.2.2.1. Property NGFF CoordinateSystem > root items > axes > contains > name
Typestring
RequiredNo
1.2.2.2. Property NGFF CoordinateSystem > root items > axes > contains > type
Typeenum (of string)
RequiredNo

Must be one of:

1.2.2.3. Property NGFF CoordinateSystem > root items > axes > contains > unit
Typestring
RequiredNo

Generated using json-schema-for-humans on 2025-10-28 at 10:58:22 +0000