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
Copy file name to clipboardExpand all lines: index.md
+28-29Lines changed: 28 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ Examples of transitional metadata include custom additions by implementations th
44
44
Some of the JSON examples in this document include comments.
45
45
However, these are only for clarity purposes and comments MUST NOT be included in JSON objects.
46
46
47
-
# Storage format
47
+
##Storage format
48
48
49
49
OME-Zarr is implemented using the Zarr format as defined by the
50
50
[version 3 of the Zarr specification](https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html).
@@ -55,7 +55,7 @@ An overview of the layout of an OME-Zarr fileset should make understanding the f
55
55
The hierarchy is represented here as it would appear locally
56
56
but could equally be stored on a web server to be accessed via HTTP or in object storage like S3 or GCS.
57
57
58
-
## Images
58
+
###Images
59
59
60
60
The following layout describes the expected Zarr hierarchy for images with multiple levels of resolutions and optionally associated labels.
61
61
Note that the number of dimensions is variable between 2 and 5 and that axis names are arbitrary, see [multiscales metadata](#multiscales-md) for details.
@@ -99,7 +99,7 @@ Note that the number of dimensions is variable between 2 and 5 and that axis nam
99
99
└── ... # are supported.
100
100
```
101
101
102
-
## High-content screening
102
+
###High-content screening
103
103
104
104
The following specification defines the hierarchy for a high-content screening
105
105
dataset. Three groups MUST be defined above the images:
@@ -135,7 +135,7 @@ A well group SHOULD NOT be present if there are no images in the well.
135
135
└── ... # Other rows
136
136
```
137
137
138
-
# OME-Zarr Metadata
138
+
##OME-Zarr Metadata
139
139
(metadata)=
140
140
141
141
The "OME-Zarr Metadata" contains metadata keys as specified below for discovering certain types of data, especially images.
@@ -309,7 +309,7 @@ The continuous rectangle of the pixel is given
309
309
by the half-open interval `[-0.5, 0.5) x [-0.5, 0.5)` (i.e., -0.5 is included, +0.5 is excluded).
310
310
See chapter 4 and figure 4.1 of the ITK Software Guide.
311
311
312
-
## bioformats2raw.layout
312
+
###bioformats2raw.layout
313
313
314
314
(bf2raw)=
315
315
@@ -321,7 +321,7 @@ In order to capture that information within an OME-Zarr dataset, `bioformats2raw
321
321
The bioformats2raw layout has been added to v0.4 as a transitional specification to specify filesets that already exist in the wild.
322
322
An upcoming NGFF specification will replace this layout with explicit metadata.
323
323
324
-
### Layout
324
+
####Layout
325
325
326
326
(bf2raw-layout)=
327
327
@@ -338,7 +338,7 @@ series.ome.zarr # One converted fileset from bioformats2raw
338
338
└── ...
339
339
```
340
340
341
-
### bf2raw-attributes
341
+
####bf2raw-attributes
342
342
(bf2raw-attributes-md)=
343
343
344
344
The OME-Zarr Metadata in the top-level `zarr.json` file must contain the `bioformats2raw.layout` key:
@@ -361,8 +361,7 @@ The OME-Zarr Metadata in the `zarr.json` file within the OME group may contain t
361
361
:language: json
362
362
```
363
363
364
-
### Details
365
-
364
+
#### Details
366
365
(bf2raw-details)=
367
366
368
367
Conforming groups:
@@ -392,7 +391,7 @@ Conforming readers:
392
391
- MAY choose to show all images within the collection or offer the user a choice of images, as with <dfnexport="true"><abbrtitle="High-content screening">HCS</abbr></dfn> plates;
393
392
- MAY ignore other groups or arrays under the root of the hierarchy.
394
393
395
-
## "coordinateTransformations" metadata
394
+
###"coordinateTransformations" metadata
396
395
(coord-trafo-md)=
397
396
398
397
"coordinateTransformations" describe the mapping between two coordinate systems (defined by [coordinateSystems](#coordinate-systems-md)).
@@ -675,7 +674,7 @@ because it is computed with the matrix-vector multiplication:
675
674
676
675
::::
677
676
678
-
### Transformation types
677
+
####Transformation types
679
678
(trafo-types-md)=
680
679
681
680
Input and output dimensionality may be determined by the coordinate system referred to by the `input` and `output` fields, respectively.
@@ -684,7 +683,7 @@ otherwise it is given by the length of `axes` for the coordinate system with the
684
683
If the value of `output` is an array, its shape gives the output dimension,
685
684
otherwise it is given by the length of `axes` for the coordinate system with the name of the `output`.
686
685
687
-
#### identity
686
+
#####identity
688
687
(identity-md)=
689
688
690
689
`identity` transformations map input coordinates to output coordinates without modification.
@@ -711,7 +710,7 @@ y = j
711
710
712
711
::::
713
712
714
-
#### mapAxis
713
+
#####mapAxis
715
714
(mapAxis-md)=
716
715
717
716
`mapAxis` transformations describe axis permutations as a transpose vector of integers.
@@ -773,7 +772,7 @@ z = b
773
772
```
774
773
::::
775
774
776
-
#### translation
775
+
#####translation
777
776
(translation-md)=
778
777
779
778
`translation` transformations are special cases of affine transformations.
@@ -808,7 +807,7 @@ y = j - 1.42
808
807
```
809
808
::::
810
809
811
-
#### scale
810
+
#####scale
812
811
(scale-md)=
813
812
814
813
`scale` transformations are special cases of affine transformations.
@@ -857,7 +856,7 @@ these axes are typically not transformed, but must be represented in the scale p
857
856
```
858
857
::::
859
858
860
-
#### affine
859
+
#####affine
861
860
(affine-md)=
862
861
863
862
`affine`s are [matrix transformations](#matrix-trafo-md) from N-dimensional inputs to M-dimensional outputs.
@@ -950,7 +949,7 @@ these axes are typically not transformed, but must be represented in the transfo
950
949
:language: json
951
950
```
952
951
953
-
#### rotation
952
+
#####rotation
954
953
(rotation-md)=
955
954
956
955
`rotation`s are [matrix transformations](#matrix-trafo-md) that are special cases of affine transformations.
@@ -989,7 +988,7 @@ y = 1*i + 0*j
989
988
```
990
989
::::
991
990
992
-
#### inverseOf
991
+
#####inverseOf
993
992
(inverseOf-md)=
994
993
995
994
An `inverseOf` transformation contains another transformation (often non-linear),
@@ -1020,7 +1019,7 @@ a choice that many users and developers find intuitive.
1020
1019
```
1021
1020
::::
1022
1021
1023
-
#### sequence
1022
+
#####sequence
1024
1023
(sequence-md)=
1025
1024
1026
1025
A `sequence` transformation consists of an ordered array of coordinate transformations,
@@ -1071,7 +1070,7 @@ y = (j + 0.9) * 3
1071
1070
and is invertible.
1072
1071
::::
1073
1072
1074
-
#### coordinates and displacements
1073
+
#####coordinates and displacements
1075
1074
(coordinates-displacements-md)=
1076
1075
1077
1076
`coordinates` and `displacements` transformations store coordinates or displacements in an array
@@ -1285,7 +1284,7 @@ I.e. the y-displacement is first, because the y-axis is the first element of the
1285
1284
1286
1285
::::
1287
1286
1288
-
#### byDimension
1287
+
#####byDimension
1289
1288
(byDimension-md)=
1290
1289
1291
1290
`byDimension` transformations build a high dimensional transformation
@@ -1353,7 +1352,7 @@ Another **invalid** `byDimension` transform:
1353
1352
This transformation is invalid because the output axis `x` appears in more than one transformation in the `transformations` list.
1354
1353
::::
1355
1354
1356
-
#### bijection
1355
+
#####bijection
1357
1356
(bijection-md)=
1358
1357
1359
1358
A bijection transformation is an invertible transformation in
@@ -1389,7 +1388,7 @@ the input and output of the `forward` and `inverse` transformations are understo
1389
1388
```
1390
1389
::::
1391
1390
1392
-
## "multiscales" metadata
1391
+
###"multiscales" metadata
1393
1392
(multiscales-md)=
1394
1393
1395
1394
Metadata about an image can be found under the `multiscales` key in the group-level OME-Zarr Metadata.
@@ -1490,7 +1489,7 @@ if not datasets:
1490
1489
datasets = [x["path"] for x in multiscales[0]["datasets"]]
1491
1490
```
1492
1491
1493
-
## "omero" metadata (transitional)
1492
+
###"omero" metadata (transitional)
1494
1493
(omero-md)=
1495
1494
1496
1495
[=Transitional=] information specific to the channels of an image and how to render it can be found under the "omero" key in the group-level metadata:
@@ -1535,7 +1534,7 @@ which are the minimum and maximum values of the window, respectively.
1535
1534
It MUST also contain the fields "start" and "end",
1536
1535
which are the start and end values of the window, respectively.
1537
1536
1538
-
## "labels" metadata
1537
+
###"labels" metadata
1539
1538
(labels-md)=
1540
1539
1541
1540
In OME-Zarr, Zarr arrays representing pixel-annotation data are stored in a group called "labels".
@@ -1617,7 +1616,7 @@ Pixels with a 1 in the Zarr array, which correspond to cellular space, will be d
1617
1616
````
1618
1617
1619
1618
1620
-
## "plate" metadata
1619
+
###"plate" metadata
1621
1620
(plate-md)=
1622
1621
1623
1622
For high-content screening datasets,
@@ -1702,7 +1701,7 @@ containing one field of view per acquisition.
1702
1701
```
1703
1702
````
1704
1703
1705
-
## "well" metadata
1704
+
###"well" metadata
1706
1705
(well-md)=
1707
1706
1708
1707
For high-content screening datasets,
@@ -1737,14 +1736,14 @@ The first field is part of the first acquisition, and the second field is part o
1737
1736
```
1738
1737
````
1739
1738
1740
-
# Specification naming style
1739
+
##Specification naming style
1741
1740
(naming-style)=
1742
1741
1743
1742
Multi-word keys in this specification should use the `camelCase` style.
1744
1743
NB: some parts of the specification don't obey this convention as they were added before this was adopted,
1745
1744
but they should be updated in due course.
1746
1745
1747
-
# Implementations
1746
+
##Implementations
1748
1747
(implementations-md)=
1749
1748
1750
1749
See [Tools](https://ngff.openmicroscopy.org/tools/index.html).
0 commit comments