Skip to article frontmatterSkip to article content

NGFF Image

Title: NGFF Image

Typeobject
RequiredNo
Additional propertiesAny type allowed

Description: JSON from OME-NGFF .zattrs

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ multiscalesNoarray of objectNo-The multiscale datasets for this image
- omeroNoobjectNo--

1. Property NGFF Image > multiscales

Typearray of object
RequiredYes

Description: The multiscale datasets for this image

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

1.1. NGFF Image > multiscales > multiscales items

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- nameNostringNo--
+ datasetsNoarray of objectNo--
- versionNoenum (of string)No--
+ axesNoarray of stringNo--

1.1.1. Property NGFF Image > multiscales > multiscales items > name

Typestring
RequiredNo

1.1.2. Property NGFF Image > multiscales > multiscales items > datasets

Typearray of object
RequiredYes
Array restrictions
Min items1
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
datasets items-
1.1.2.1. NGFF Image > multiscales > multiscales items > datasets > datasets items
Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ pathNostringNo--
1.1.2.1.1. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > path
Typestring
RequiredYes

1.1.3. Property NGFF Image > multiscales > multiscales items > version

Typeenum (of string)
RequiredNo

Must be one of:

1.1.4. Property NGFF Image > multiscales > multiscales items > axes

Typearray of string
RequiredYes
Array restrictions
Min items2
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
axes items-
1.1.4.1. NGFF Image > multiscales > multiscales items > axes > axes items
Typestring
RequiredNo
Restrictions
Must match regular expression^[xyzct]$ Test

2. Property NGFF Image > omero

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ channelsNoarray of objectNo--

2.1. Property NGFF Image > omero > channels

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

2.1.1. NGFF Image > omero > channels > channels items

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ windowNoobjectNo--
- labelNostringNo--
- familyNostringNo--
+ colorNostringNo--
- activeNobooleanNo--
2.1.1.1. Property NGFF Image > omero > channels > channels items > window
Typeobject
RequiredYes
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ endNonumberNo--
+ maxNonumberNo--
+ minNonumberNo--
+ startNonumberNo--
2.1.1.1.1. Property NGFF Image > omero > channels > channels items > window > end
Typenumber
RequiredYes
2.1.1.1.2. Property NGFF Image > omero > channels > channels items > window > max
Typenumber
RequiredYes
2.1.1.1.3. Property NGFF Image > omero > channels > channels items > window > min
Typenumber
RequiredYes
2.1.1.1.4. Property NGFF Image > omero > channels > channels items > window > start
Typenumber
RequiredYes
2.1.1.2. Property NGFF Image > omero > channels > channels items > label
Typestring
RequiredNo
2.1.1.3. Property NGFF Image > omero > channels > channels items > family
Typestring
RequiredNo
2.1.1.4. Property NGFF Image > omero > channels > channels items > color
Typestring
RequiredYes
2.1.1.5. Property NGFF Image > omero > channels > channels items > active
Typeboolean
RequiredNo

Generated using json-schema-for-humans on 2026-01-13 at 13:45:18 +0000