Skip to article frontmatterSkip to article content

OME-NGFF plate schema

Title: OME-NGFF plate schema

Typeobject
RequiredNo
Additional propertiesAny type allowed

Description: JSON from OME-NGFF .zattrs

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- plateNoobjectNo--

1. Property OME-NGFF plate schema > plate

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- acquisitionsNoarray of objectNo-The acquisitions for this plate
- versionNoenum (of string)No-The version of the specification
- field_countNointegerNo-The maximum number of fields per view across all wells
- nameNostringNo-The name of the plate
+ columnsNoarray of objectNo-The columns of the plate
+ rowsNoarray of objectNo-The rows of the plate
+ wellsNoarray of objectNo-The wells of the plate

1.1. Property OME-NGFF plate schema > plate > acquisitions

Typearray of object
RequiredNo

Description: The acquisitions for this plate

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
acquisitions items-

1.1.1. OME-NGFF plate schema > plate > acquisitions > acquisitions items

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ idNointegerNo-A unique identifier within the context of the plate
- maximumfieldcountNointegerNo-The maximum number of fields of view for the acquisition
- nameNostringNo-The name of the acquisition
- descriptionNostringNo-The description of the acquisition
- starttimeNointegerNo-The start timestamp of the acquisition, expressed as epoch time i.e. the number seconds since the Epoch
- endtimeNointegerNo-The end timestamp of the acquisition, expressed as epoch time i.e. the number seconds since the Epoch
1.1.1.1. Property OME-NGFF plate schema > plate > acquisitions > acquisitions items > id
Typeinteger
RequiredYes

Description: A unique identifier within the context of the plate

Restrictions
Minimum≥ 0
1.1.1.2. Property OME-NGFF plate schema > plate > acquisitions > acquisitions items > maximumfieldcount
Typeinteger
RequiredNo

Description: The maximum number of fields of view for the acquisition

Restrictions
Minimum> 0
1.1.1.3. Property OME-NGFF plate schema > plate > acquisitions > acquisitions items > name
Typestring
RequiredNo

Description: The name of the acquisition

1.1.1.4. Property OME-NGFF plate schema > plate > acquisitions > acquisitions items > description
Typestring
RequiredNo

Description: The description of the acquisition

1.1.1.5. Property OME-NGFF plate schema > plate > acquisitions > acquisitions items > starttime
Typeinteger
RequiredNo

Description: The start timestamp of the acquisition, expressed as epoch time i.e. the number seconds since the Epoch

Restrictions
Minimum≥ 0
1.1.1.6. Property OME-NGFF plate schema > plate > acquisitions > acquisitions items > endtime
Typeinteger
RequiredNo

Description: The end timestamp of the acquisition, expressed as epoch time i.e. the number seconds since the Epoch

Restrictions
Minimum≥ 0

1.2. Property OME-NGFF plate schema > plate > version

Typeenum (of string)
RequiredNo

Description: The version of the specification

Must be one of:

1.3. Property OME-NGFF plate schema > plate > field_count

Typeinteger
RequiredNo

Description: The maximum number of fields per view across all wells

Restrictions
Minimum> 0

1.4. Property OME-NGFF plate schema > plate > name

Typestring
RequiredNo

Description: The name of the plate

1.5. Property OME-NGFF plate schema > plate > columns

Typearray of object
RequiredYes

Description: The columns of the plate

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

1.5.1. OME-NGFF plate schema > plate > columns > columns items

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-The column name
1.5.1.1. Property OME-NGFF plate schema > plate > columns > columns items > name
Typestring
RequiredYes

Description: The column name

Restrictions
Must match regular expression^[A-Za-z0-9]+$ Test

1.6. Property OME-NGFF plate schema > plate > rows

Typearray of object
RequiredYes

Description: The rows of the plate

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

1.6.1. OME-NGFF plate schema > plate > rows > rows items

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-The row name
1.6.1.1. Property OME-NGFF plate schema > plate > rows > rows items > name
Typestring
RequiredYes

Description: The row name

Restrictions
Must match regular expression^[A-Za-z0-9]+$ Test

1.7. Property OME-NGFF plate schema > plate > wells

Typearray of object
RequiredYes

Description: The wells of the plate

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

1.7.1. OME-NGFF plate schema > plate > wells > wells items

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ pathNostringNo-The path to the well subgroup
+ rowIndexNointegerNo-The index of the well in the rows list
+ columnIndexNointegerNo-The index of the well in the columns list
1.7.1.1. Property OME-NGFF plate schema > plate > wells > wells items > path
Typestring
RequiredYes

Description: The path to the well subgroup

Restrictions
Must match regular expression^[A-Za-z0-9]+/[A-Za-z0-9]+$ Test
1.7.1.2. Property OME-NGFF plate schema > plate > wells > wells items > rowIndex
Typeinteger
RequiredYes

Description: The index of the well in the rows list

Restrictions
Minimum≥ 0
1.7.1.3. Property OME-NGFF plate schema > plate > wells > wells items > columnIndex
Typeinteger
RequiredYes

Description: The index of the well in the columns list

Restrictions
Minimum≥ 0

Generated using json-schema-for-humans on 2026-01-13 at 13:42:05 +0000