You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The "axes" are used as part of [[#multiscale-md]]. The length of "axes" MUST be equal to the number of dimensions of the arrays that contain the image data.
193
+
The "axes" are used as part of [multiscales metadata](#version0.5:multiscale-md). The length of "axes" MUST be equal to the number of dimensions of the arrays that contain the image data.
194
194
195
195
The "dimension_names" attribute MUST be included in the `zarr.json` of the Zarr array of a multiscale level and MUST match the names in the "axes" metadata.
196
196
197
197
198
198
### "bioformats2raw.layout" (transitional)
199
-
(bf2raw)=
199
+
(version0.5:bf2raw)=
200
200
201
201
[=Transitional=] "bioformats2raw.layout" metadata identifies a group which implicitly describes a series of images.
202
202
The need for the collection stems from the common "multi-image file" scenario in microscopy. Parsers like Bio-Formats
@@ -223,7 +223,7 @@ series.ome.zarr # One converted fileset from bioformats2raw
223
223
</pre>
224
224
225
225
#### Attributes
226
-
(bf2raw-attributes)=
226
+
(version0.5:bf2raw-attributes)=
227
227
228
228
The OME-Zarr Metadata in the top-level `zarr.json` file must contain the `bioformats2raw.layout` key:
229
229
<preclass=include-code>
@@ -248,7 +248,7 @@ highlight: json
248
248
</pre>
249
249
250
250
#### Details
251
-
(bf2raw-details)=
251
+
(version0.5:bf2raw-details)=
252
252
253
253
Conforming groups:
254
254
@@ -278,7 +278,7 @@ Conforming readers:
278
278
279
279
280
280
### "coordinateTransformations" metadata
281
-
(trafo-md)=
281
+
(version0.5:trafo-md)=
282
282
283
283
"coordinateTransformations" describe a series of transformations that map between two coordinate spaces (defined by "axes").
284
284
For example, to map a discrete data space of an array to the corresponding physical space.
@@ -298,15 +298,15 @@ The transformations in the list are applied sequentially and in order.
298
298
299
299
300
300
### "multiscales" metadata
301
-
(multiscale-md)=
301
+
(version0.5:multiscale-md)=
302
302
303
303
Metadata about an image can be found under the "multiscales" key in the group-level OME-Zarr Metadata.
304
304
Here, image refers to 2 to 5 dimensional data representing image or volumetric data with optional time or channel axes.
305
305
It is stored in a multiple resolution representation.
306
306
307
307
"multiscales" contains a list of dictionaries where each entry describes a multiscale image.
308
308
309
-
Each "multiscales" dictionary MUST contain the field "axes", see [[#axes-md]].
309
+
Each "multiscales" dictionary MUST contain the field "axes", see [axes metadata](#version0.5:axes-md).
310
310
The length of "axes" must be between 2 and 5 and MUST be equal to the dimensionality of the zarr arrays storing the image data (see "datasets:path").
311
311
The "axes" MUST contain 2 or 3 entries of "type:space" and MAY contain one additional entry of "type:time" and MAY contain one additional entry of "type:channel" or a null / custom type.
312
312
The order of the entries MUST correspond to the order of dimensions of the zarr arrays. In addition, the entries MUST be ordered by "type" where the "time" axis must come first (if present), followed by the "channel" or custom axis (if present) and the axes of type "space".
@@ -318,7 +318,7 @@ to the current zarr group. The "path"s MUST be ordered from largest (i.e. highes
318
318
319
319
Each "datasets" dictionary MUST have the same number of dimensions and MUST NOT have more than 5 dimensions. The number of dimensions and order MUST correspond to number and order of "axes".
320
320
Each dictionary in "datasets" MUST contain the field "coordinateTransformations", which contains a list of transformations that map the data coordinates to the physical coordinates (as specified by "axes") for this resolution level.
321
-
The transformations are defined according to [[#trafo-md]]. The transformation MUST only be of type `translation` or `scale`.
321
+
The transformations are defined according to [transformations metadata](#version0.5:trafo-md). The transformation MUST only be of type `translation` or `scale`.
322
322
They MUST contain exactly one `scale` transformation that specifies the pixel size in physical units or time duration. If scaling information is not available or applicable for one of the axes, the value MUST express the scaling factor between the current resolution and the first resolution for the given axis, defaulting to 1.0 if there is no downsampling along the axis.
323
323
It MAY contain exactly one `translation` that specifies the offset from the origin in physical units. If `translation` is given it MUST be listed after `scale` to ensure that it is given in physical coordinates.
324
324
The length of the `scale` and `translation` array MUST be the same as the length of "axes".
@@ -354,7 +354,7 @@ if not datasets:
354
354
```
355
355
356
356
### "omero" metadata (transitional)
357
-
(omero-md)=
357
+
(version0.5:omero-md)=
358
358
359
359
[=Transitional=] information specific to the channels of an image and how to render it
360
360
can be found under the "omero" key in the group-level metadata:
@@ -395,7 +395,7 @@ The field "window" MUST contain the fields "min" and "max", which are the minimu
395
395
It MUST also contain the fields "start" and "end", which are the start and end values of the window, respectively.
396
396
397
397
### "labels" metadata
398
-
(labels-md)=
398
+
(version0.5:labels-md)=
399
399
400
400
In OME-Zarr, Zarr arrays representing pixel-annotation data are stored in a group called "labels". Some applications--notably image segmentation--produce
401
401
a new image that is in the same coordinate system as a corresponding multiscale image (usually having the same dimensions and coordinate transformations).
@@ -463,7 +463,7 @@ In this case, the pixels consisting of a 0 in the Zarr array will be displayed a
463
463
which correspond to cellular space, will be displayed as 50% green and 50% opacity.
464
464
465
465
### "plate" metadata
466
-
(plate-md)=
466
+
(version0.5:plate-md)=
467
467
468
468
For high-content screening datasets, the plate layout can be found under the
469
469
custom attributes of the plate group under the `plate` key in the group-level metadata.
@@ -535,7 +535,7 @@ highlight: json
535
535
</pre>
536
536
537
537
### "well" metadata
538
-
(well-md)=
538
+
(version0.5:well-md)=
539
539
540
540
For high-content screening datasets, the metadata about all fields of views
541
541
under a given well can be found under the "well" key in the attributes of the
@@ -571,7 +571,7 @@ highlight: json
571
571
</pre>
572
572
573
573
## Specification naming style
574
-
(naming-style)=
574
+
(version0.5:naming-style)=
575
575
576
576
Multi-word keys in this specification should use the `camelCase` style.
577
577
NB: some parts of the specification don't obey this convention as they
@@ -582,99 +582,6 @@ were added before this was adopted, but they should be updated in due course.
582
582
583
583
See [Tools](https://ngff.openmicroscopy.org/tools/index.html).
584
584
585
-
## Citing
586
-
(citing)=
587
-
588
-
[Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.](https://ngff.openmicroscopy.org/0.4)
589
-
J. Moore, *et al*. Open Microscopy Environment Consortium, 8 February 2022.
590
-
This edition of the specification is [https://ngff.openmicroscopy.org/0.5/](https://ngff.openmicroscopy.org/0.5/]).
591
-
The latest edition is available at [https://ngff.openmicroscopy.org/latest/](https://ngff.openmicroscopy.org/latest/).
0 commit comments