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--
+ axesNoarrayNoIn #/$defs/axes-
- coordinateTransformationsNoarrayNoSame as coordinateTransformations-

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--
+ coordinateTransformationsNoarrayNoIn #/$defs/coordinateTransformations-
1.1.2.1.1. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > path
Typestring
RequiredYes
1.1.2.1.2. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations
Typearray
RequiredYes
Defined in#/$defs/coordinateTransformations
Array restrictions
Min items1
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
coordinateTransformations items-
1.1.2.1.2.1. NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items
Typecombining
RequiredNo
Additional propertiesAny type allowed
One of(Option)
item 0
item 1
1.1.2.1.2.1.1. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items > oneOf > item 0
Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ typeNoenum (of string)No--
+ scaleNoarray of numberNo--
1.1.2.1.2.1.1.1. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items > oneOf > item 0 > type
Typeenum (of string)
RequiredYes

Must be one of:

1.1.2.1.2.1.1.2. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items > oneOf > item 0 > scale
Typearray of number
RequiredYes
Array restrictions
Min items2
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
scale items-
1.1.2.1.2.1.1.2.1. NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items > oneOf > item 0 > scale > scale items
Typenumber
RequiredNo
1.1.2.1.2.1.2. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items > oneOf > item 1
Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ typeNoenum (of string)No--
+ translationNoarray of numberNo--
1.1.2.1.2.1.2.1. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items > oneOf > item 1 > type
Typeenum (of string)
RequiredYes

Must be one of:

1.1.2.1.2.1.2.2. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items > oneOf > item 1 > translation
Typearray of number
RequiredYes
Array restrictions
Min items2
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
translation items-
1.1.2.1.2.1.2.2.1. NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > coordinateTransformations items > oneOf > item 1 > translation > translation items
Typenumber
RequiredNo
1.1.2.1.2.2. At least one of the items must be
Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- typeNoenum (of string)No--
- scaleNoarray of numberNo--
1.1.2.1.2.2.1. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > contains > type
Typeenum (of string)
RequiredNo

Must be one of:

1.1.2.1.2.2.2. Property NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > contains > scale
Typearray of number
RequiredNo
Array restrictions
Min items2
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
scale items-
1.1.2.1.2.2.2.1. NGFF Image > multiscales > multiscales items > datasets > datasets items > coordinateTransformations > contains > scale > scale items
Typenumber
RequiredNo

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
RequiredYes
Defined in#/$defs/axes
Array restrictions
Min items2
Max items5
Items unicityTrue
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
Typecombining
RequiredNo
Additional propertiesAny type allowed
One of(Option)
item 0
item 1
1.1.4.1.1. Property NGFF Image > multiscales > multiscales items > axes > axes items > oneOf > item 0
Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo--
+ typeNoenum (of string)No--
1.1.4.1.1.1. Property NGFF Image > multiscales > multiscales items > axes > axes items > oneOf > item 0 > name
Typestring
RequiredYes
1.1.4.1.1.2. Property NGFF Image > multiscales > multiscales items > axes > axes items > oneOf > item 0 > type
Typeenum (of string)
RequiredYes

Must be one of:

1.1.4.1.2. Property NGFF Image > multiscales > multiscales items > axes > axes items > oneOf > item 1
Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo--
- typeNoCombinationNo--
1.1.4.1.2.1. Property NGFF Image > multiscales > multiscales items > axes > axes items > oneOf > item 1 > name
Typestring
RequiredYes
1.1.4.1.2.2. Property NGFF Image > multiscales > multiscales items > axes > axes items > oneOf > item 1 > type
Typecombining
RequiredNo
1.1.4.1.2.2.1. Must not be
Typeenum (of string)
RequiredNo

Must be one of:

1.1.4.2. At least one of the items must be
Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- nameNostringNo--
- typeNoenum (of string)No--
- unitNostringNo--
1.1.4.2.1. Property NGFF Image > multiscales > multiscales items > axes > contains > name
Typestring
RequiredNo
1.1.4.2.2. Property NGFF Image > multiscales > multiscales items > axes > contains > type
Typeenum (of string)
RequiredNo

Must be one of:

1.1.4.2.3. Property NGFF Image > multiscales > multiscales items > axes > contains > unit
Typestring
RequiredNo

1.1.5. Property NGFF Image > multiscales > multiscales items > coordinateTransformations

Typearray
RequiredNo
Same definition ascoordinateTransformations

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:42:05 +0000