Skip to content

Commit c402df1

Browse files
committed
changer header levels
1 parent 5650481 commit c402df1

File tree

1 file changed

+28
-29
lines changed

1 file changed

+28
-29
lines changed

index.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Examples of transitional metadata include custom additions by implementations th
4444
Some of the JSON examples in this document include comments.
4545
However, these are only for clarity purposes and comments MUST NOT be included in JSON objects.
4646

47-
# Storage format
47+
## Storage format
4848

4949
OME-Zarr is implemented using the Zarr format as defined by the
5050
[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
5555
The hierarchy is represented here as it would appear locally
5656
but could equally be stored on a web server to be accessed via HTTP or in object storage like S3 or GCS.
5757

58-
## Images
58+
### Images
5959

6060
The following layout describes the expected Zarr hierarchy for images with multiple levels of resolutions and optionally associated labels.
6161
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
9999
└── ... # are supported.
100100
```
101101

102-
## High-content screening
102+
### High-content screening
103103

104104
The following specification defines the hierarchy for a high-content screening
105105
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.
135135
└── ... # Other rows
136136
```
137137

138-
# OME-Zarr Metadata
138+
## OME-Zarr Metadata
139139
(metadata)=
140140

141141
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
309309
by the half-open interval `[-0.5, 0.5) x [-0.5, 0.5)` (i.e., -0.5 is included, +0.5 is excluded).
310310
See chapter 4 and figure 4.1 of the ITK Software Guide.
311311

312-
## bioformats2raw.layout
312+
### bioformats2raw.layout
313313

314314
(bf2raw)=
315315

@@ -321,7 +321,7 @@ In order to capture that information within an OME-Zarr dataset, `bioformats2raw
321321
The bioformats2raw layout has been added to v0.4 as a transitional specification to specify filesets that already exist in the wild.
322322
An upcoming NGFF specification will replace this layout with explicit metadata.
323323

324-
### Layout
324+
#### Layout
325325

326326
(bf2raw-layout)=
327327

@@ -338,7 +338,7 @@ series.ome.zarr # One converted fileset from bioformats2raw
338338
└── ...
339339
```
340340

341-
### bf2raw-attributes
341+
#### bf2raw-attributes
342342
(bf2raw-attributes-md)=
343343

344344
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
361361
:language: json
362362
```
363363

364-
### Details
365-
364+
#### Details
366365
(bf2raw-details)=
367366

368367
Conforming groups:
@@ -392,7 +391,7 @@ Conforming readers:
392391
- MAY choose to show all images within the collection or offer the user a choice of images, as with <dfn export="true"><abbr title="High-content screening">HCS</abbr></dfn> plates;
393392
- MAY ignore other groups or arrays under the root of the hierarchy.
394393

395-
## "coordinateTransformations" metadata
394+
### "coordinateTransformations" metadata
396395
(coord-trafo-md)=
397396

398397
"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:
675674

676675
::::
677676

678-
### Transformation types
677+
#### Transformation types
679678
(trafo-types-md)=
680679

681680
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
684683
If the value of `output` is an array, its shape gives the output dimension,
685684
otherwise it is given by the length of `axes` for the coordinate system with the name of the `output`.
686685

687-
#### identity
686+
##### identity
688687
(identity-md)=
689688

690689
`identity` transformations map input coordinates to output coordinates without modification.
@@ -711,7 +710,7 @@ y = j
711710

712711
::::
713712

714-
#### mapAxis
713+
##### mapAxis
715714
(mapAxis-md)=
716715

717716
`mapAxis` transformations describe axis permutations as a transpose vector of integers.
@@ -773,7 +772,7 @@ z = b
773772
```
774773
::::
775774

776-
#### translation
775+
##### translation
777776
(translation-md)=
778777

779778
`translation` transformations are special cases of affine transformations.
@@ -808,7 +807,7 @@ y = j - 1.42
808807
```
809808
::::
810809

811-
#### scale
810+
##### scale
812811
(scale-md)=
813812

814813
`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
857856
```
858857
::::
859858

860-
#### affine
859+
##### affine
861860
(affine-md)=
862861

863862
`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
950949
:language: json
951950
```
952951

953-
#### rotation
952+
##### rotation
954953
(rotation-md)=
955954

956955
`rotation`s are [matrix transformations](#matrix-trafo-md) that are special cases of affine transformations.
@@ -989,7 +988,7 @@ y = 1*i + 0*j
989988
```
990989
::::
991990

992-
#### inverseOf
991+
##### inverseOf
993992
(inverseOf-md)=
994993

995994
An `inverseOf` transformation contains another transformation (often non-linear),
@@ -1020,7 +1019,7 @@ a choice that many users and developers find intuitive.
10201019
```
10211020
::::
10221021

1023-
#### sequence
1022+
##### sequence
10241023
(sequence-md)=
10251024

10261025
A `sequence` transformation consists of an ordered array of coordinate transformations,
@@ -1071,7 +1070,7 @@ y = (j + 0.9) * 3
10711070
and is invertible.
10721071
::::
10731072

1074-
#### coordinates and displacements
1073+
##### coordinates and displacements
10751074
(coordinates-displacements-md)=
10761075

10771076
`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
12851284

12861285
::::
12871286

1288-
#### byDimension
1287+
##### byDimension
12891288
(byDimension-md)=
12901289

12911290
`byDimension` transformations build a high dimensional transformation
@@ -1353,7 +1352,7 @@ Another **invalid** `byDimension` transform:
13531352
This transformation is invalid because the output axis `x` appears in more than one transformation in the `transformations` list.
13541353
::::
13551354

1356-
#### bijection
1355+
##### bijection
13571356
(bijection-md)=
13581357

13591358
A bijection transformation is an invertible transformation in
@@ -1389,7 +1388,7 @@ the input and output of the `forward` and `inverse` transformations are understo
13891388
```
13901389
::::
13911390

1392-
## "multiscales" metadata
1391+
### "multiscales" metadata
13931392
(multiscales-md)=
13941393

13951394
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:
14901489
datasets = [x["path"] for x in multiscales[0]["datasets"]]
14911490
```
14921491

1493-
## "omero" metadata (transitional)
1492+
### "omero" metadata (transitional)
14941493
(omero-md)=
14951494

14961495
[=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.
15351534
It MUST also contain the fields "start" and "end",
15361535
which are the start and end values of the window, respectively.
15371536

1538-
## "labels" metadata
1537+
### "labels" metadata
15391538
(labels-md)=
15401539

15411540
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
16171616
````
16181617

16191618

1620-
## "plate" metadata
1619+
### "plate" metadata
16211620
(plate-md)=
16221621

16231622
For high-content screening datasets,
@@ -1702,7 +1701,7 @@ containing one field of view per acquisition.
17021701
```
17031702
````
17041703

1705-
## "well" metadata
1704+
### "well" metadata
17061705
(well-md)=
17071706

17081707
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
17371736
```
17381737
````
17391738

1740-
# Specification naming style
1739+
## Specification naming style
17411740
(naming-style)=
17421741

17431742
Multi-word keys in this specification should use the `camelCase` style.
17441743
NB: some parts of the specification don't obey this convention as they were added before this was adopted,
17451744
but they should be updated in due course.
17461745

1747-
# Implementations
1746+
## Implementations
17481747
(implementations-md)=
17491748

17501749
See [Tools](https://ngff.openmicroscopy.org/tools/index.html).

0 commit comments

Comments
 (0)