---
author: ""
---
(schemas:ome)=

# OME

- [1. Property `OME > ome`](#ome)
  - [1.1. Property `OME > ome > series`](#ome_series)
    - [1.1.1. OME > ome > series > series items](#autogenerated_heading_2)
  - [1.2. Property `OME > ome > version`](#ome_version)

**Title:** OME

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | No                                                                        |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

**Description:** OME-Zarr OME metadata.

| Property       | Pattern | Type   | Deprecated | Definition | Title/Description                         |
| -------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------- |
| + [ome](#ome ) | No      | object | No         | -          | The versioned OME-Zarr Metadata namespace |

## <a name="ome"></a>1. Property `OME > ome`

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | Yes                                                                       |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

**Description:** The versioned OME-Zarr Metadata namespace

| Property                   | Pattern | Type            | Deprecated | Definition                                                          | Title/Description                                                                                             |
| -------------------------- | ------- | --------------- | ---------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| + [series](#ome_series )   | No      | array of string | No         | -                                                                   | An array of the same length and the same order as the images defined in the OME-XML                           |
| + [version](#ome_version ) | No      | object          | No         | In https://ngff.openmicroscopy.org/0.6.dev3/schemas/_version.schema | 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️ |

### <a name="ome_series"></a>1.1. Property `OME > ome > series`

|              |                   |
| ------------ | ----------------- |
| **Type**     | `array of string` |
| **Required** | Yes               |

**Description:** An array of the same length and the same order as the images defined in the OME-XML

|                      | Array restrictions |
| -------------------- | ------------------ |
| **Min items**        | N/A                |
| **Max items**        | N/A                |
| **Items unicity**    | False              |
| **Additional items** | False              |
| **Tuple validation** | See below          |

| Each item of this array must be   | Description |
| --------------------------------- | ----------- |
| [series items](#ome_series_items) | -           |

#### <a name="autogenerated_heading_2"></a>1.1.1. OME > ome > series > series items

|              |          |
| ------------ | -------- |
| **Type**     | `string` |
| **Required** | No       |

### <a name="ome_version"></a>1.2. Property `OME > ome > version`

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | Yes                                                                       |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| **Defined in**            | https://ngff.openmicroscopy.org/0.6.dev3/schemas/_version.schema          |

**Description:** 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️

----------------------------------------------------------------------------------------------------------------------------
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-01 at 17:39:11 +0000