---
author: ""
---
(schemas:image)=
# NGFF Image
- [1. Property `NGFF Image > multiscales`](#multiscales)
- [1.1. NGFF Image > multiscales > multiscales items](#multiscales_items)
- [1.1.1. Property `NGFF Image > multiscales > multiscales items > name`](#multiscales_items_name)
- [1.1.2. Property `NGFF Image > multiscales > multiscales items > datasets`](#multiscales_items_datasets)
- [1.1.2.1. NGFF Image > multiscales > multiscales items > datasets > datasets items](#multiscales_items_datasets_items)
- [1.1.2.1.1. Property `NGFF Image > multiscales > multiscales items > datasets > datasets items > path`](#multiscales_items_datasets_items_path)
- [1.1.3. Property `NGFF Image > multiscales > multiscales items > version`](#multiscales_items_version)
- [1.1.4. Property `NGFF Image > multiscales > multiscales items > metadata`](#multiscales_items_metadata)
- [1.1.4.1. Property `NGFF Image > multiscales > multiscales items > metadata > method`](#multiscales_items_metadata_method)
- [1.1.4.2. Property `NGFF Image > multiscales > multiscales items > metadata > version`](#multiscales_items_metadata_version)
- [2. Property `NGFF Image > omero`](#omero)
- [2.1. Property `NGFF Image > omero > channels`](#omero_channels)
- [2.1.1. NGFF Image > omero > channels > channels items](#omero_channels_items)
- [2.1.1.1. Property `NGFF Image > omero > channels > channels items > window`](#omero_channels_items_window)
- [2.1.1.1.1. Property `NGFF Image > omero > channels > channels items > window > end`](#omero_channels_items_window_end)
- [2.1.1.1.2. Property `NGFF Image > omero > channels > channels items > window > max`](#omero_channels_items_window_max)
- [2.1.1.1.3. Property `NGFF Image > omero > channels > channels items > window > min`](#omero_channels_items_window_min)
- [2.1.1.1.4. Property `NGFF Image > omero > channels > channels items > window > start`](#omero_channels_items_window_start)
- [2.1.1.2. Property `NGFF Image > omero > channels > channels items > label`](#omero_channels_items_label)
- [2.1.1.3. Property `NGFF Image > omero > channels > channels items > family`](#omero_channels_items_family)
- [2.1.1.4. Property `NGFF Image > omero > channels > channels items > color`](#omero_channels_items_color)
- [2.1.1.5. Property `NGFF Image > omero > channels > channels items > active`](#omero_channels_items_active)
**Title:** NGFF Image
| | |
| ------------------------- | ---------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | Any type allowed |
**Description:** JSON from OME-NGFF .zattrs
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ------------------------------ | ------- | --------------- | ---------- | ---------- | -------------------------------------- |
| + [multiscales](#multiscales ) | No | array of object | No | - | The multiscale datasets for this image |
| - [omero](#omero ) | No | object | No | - | - |
## 1. Property `NGFF Image > multiscales`
| | |
| ------------ | ----------------- |
| **Type** | `array of object` |
| **Required** | Yes |
**Description:** The multiscale datasets for this image
| | Array restrictions |
| -------------------- | ------------------ |
| **Min items** | 1 |
| **Max items** | N/A |
| **Items unicity** | True |
| **Additional items** | False |
| **Tuple validation** | See below |
| Each item of this array must be | Description |
| --------------------------------------- | ----------- |
| [multiscales items](#multiscales_items) | - |
### 1.1. NGFF Image > multiscales > multiscales items
| | |
| ------------------------- | ---------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ------------------------------------------ | ------- | ---------------- | ---------- | ---------- | ----------------- |
| - [name](#multiscales_items_name ) | No | string | No | - | - |
| + [datasets](#multiscales_items_datasets ) | No | array of object | No | - | - |
| - [version](#multiscales_items_version ) | No | enum (of string) | No | - | - |
| - [metadata](#multiscales_items_metadata ) | No | object | No | - | - |
#### 1.1.1. Property `NGFF Image > multiscales > multiscales items > name`
| | |
| ------------ | -------- |
| **Type** | `string` |
| **Required** | No |
#### 1.1.2. Property `NGFF Image > multiscales > multiscales items > datasets`
| | |
| ------------ | ----------------- |
| **Type** | `array of object` |
| **Required** | Yes |
| | Array restrictions |
| -------------------- | ------------------ |
| **Min items** | 1 |
| **Max items** | N/A |
| **Items unicity** | False |
| **Additional items** | False |
| **Tuple validation** | See below |
| Each item of this array must be | Description |
| --------------------------------------------------- | ----------- |
| [datasets items](#multiscales_items_datasets_items) | - |
##### 1.1.2.1. NGFF Image > multiscales > multiscales items > datasets > datasets items
| | |
| ------------------------- | ---------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
| + [path](#multiscales_items_datasets_items_path ) | No | string | No | - | - |
###### 1.1.2.1.1. Property `NGFF Image > multiscales > multiscales items > datasets > datasets items > path`
| | |
| ------------ | -------- |
| **Type** | `string` |
| **Required** | Yes |
#### 1.1.3. Property `NGFF Image > multiscales > multiscales items > version`
| | |
| ------------ | ------------------ |
| **Type** | `enum (of string)` |
| **Required** | No |
Must be one of:
* "0.1"
#### 1.1.4. Property `NGFF Image > multiscales > multiscales items > metadata`
| | |
| ------------------------- | ---------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
| - [method](#multiscales_items_metadata_method ) | No | string | No | - | - |
| - [version](#multiscales_items_metadata_version ) | No | string | No | - | - |
##### 1.1.4.1. Property `NGFF Image > multiscales > multiscales items > metadata > method`
| | |
| ------------ | -------- |
| **Type** | `string` |
| **Required** | No |
##### 1.1.4.2. Property `NGFF Image > multiscales > multiscales items > metadata > version`
| | |
| ------------ | -------- |
| **Type** | `string` |
| **Required** | No |
## 2. Property `NGFF Image > omero`
| | |
| ------------------------- | ---------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ------------------------------ | ------- | --------------- | ---------- | ---------- | ----------------- |
| + [channels](#omero_channels ) | No | array of object | No | - | - |
### 2.1. Property `NGFF Image > omero > channels`
| | |
| ------------ | ----------------- |
| **Type** | `array of object` |
| **Required** | Yes |
| | 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 |
| --------------------------------------- | ----------- |
| [channels items](#omero_channels_items) | - |
#### 2.1.1. NGFF Image > omero > channels > channels items
| | |
| ------------------------- | ---------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ----------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
| + [window](#omero_channels_items_window ) | No | object | No | - | - |
| - [label](#omero_channels_items_label ) | No | string | No | - | - |
| - [family](#omero_channels_items_family ) | No | string | No | - | - |
| + [color](#omero_channels_items_color ) | No | string | No | - | - |
| - [active](#omero_channels_items_active ) | No | boolean | No | - | - |
##### 2.1.1.1. Property `NGFF Image > omero > channels > channels items > window`
| | |
| ------------------------- | ---------------- |
| **Type** | `object` |
| **Required** | Yes |
| **Additional properties** | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
| + [end](#omero_channels_items_window_end ) | No | number | No | - | - |
| + [max](#omero_channels_items_window_max ) | No | number | No | - | - |
| + [min](#omero_channels_items_window_min ) | No | number | No | - | - |
| + [start](#omero_channels_items_window_start ) | No | number | No | - | - |
###### 2.1.1.1.1. Property `NGFF Image > omero > channels > channels items > window > end`
| | |
| ------------ | -------- |
| **Type** | `number` |
| **Required** | Yes |
###### 2.1.1.1.2. Property `NGFF Image > omero > channels > channels items > window > max`
| | |
| ------------ | -------- |
| **Type** | `number` |
| **Required** | Yes |
###### 2.1.1.1.3. Property `NGFF Image > omero > channels > channels items > window > min`
| | |
| ------------ | -------- |
| **Type** | `number` |
| **Required** | Yes |
###### 2.1.1.1.4. Property `NGFF Image > omero > channels > channels items > window > start`
| | |
| ------------ | -------- |
| **Type** | `number` |
| **Required** | Yes |
##### 2.1.1.2. Property `NGFF Image > omero > channels > channels items > label`
| | |
| ------------ | -------- |
| **Type** | `string` |
| **Required** | No |
##### 2.1.1.3. Property `NGFF Image > omero > channels > channels items > family`
| | |
| ------------ | -------- |
| **Type** | `string` |
| **Required** | No |
##### 2.1.1.4. Property `NGFF Image > omero > channels > channels items > color`
| | |
| ------------ | -------- |
| **Type** | `string` |
| **Required** | Yes |
##### 2.1.1.5. Property `NGFF Image > omero > channels > channels items > active`
| | |
| ------------ | --------- |
| **Type** | `boolean` |
| **Required** | No |
----------------------------------------------------------------------------------------------------------------------------
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-06-11 at 20:27:50 +0000