Skip to content

Commit f42d87e

Browse files
committed
update references, citation and changelog
1 parent 05b227c commit f42d87e

3 files changed

Lines changed: 24 additions & 129 deletions

File tree

citing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ author: ""
66

77
[Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.](https://ngff.openmicroscopy.org/0.4)
88
J. Moore, *et al*. Open Microscopy Environment Consortium, 8 February 2022.
9-
10-
This edition of the specification is [https://ngff.openmicroscopy.org/{{version}}](https://ngff.openmicroscopy.org/{{version}}]).
11-
The latest edition is publicly available {cite}`ngff_spec_latest`.
9+
This edition of the specification is [https://ngff.openmicroscopy.org/0.5/](https://ngff.openmicroscopy.org/0.5/]).
10+
The latest edition is available at [https://ngff.openmicroscopy.org/latest/](https://ngff.openmicroscopy.org/latest/).
11+
[(doi:10.5281/zenodo.4282107)](https://doi.org/10.5281/zenodo.4282107)
1212

1313
```{bibliography}
1414
:style: unsrt

index.md

Lines changed: 21 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Status Text: (an "editor's draft") will not necessarily be supported.
2424
</pre>
2525

2626
## OME-Zarr specification
27-
(ome-zarr)=
27+
(version0.5:ome-zarr)=
2828

2929

3030
The conventions and specifications defined in this document are designed to
@@ -50,7 +50,7 @@ Some of the JSON examples in this document include comments. However, these are
5050
clarity purposes and comments MUST NOT be included in JSON objects.
5151

5252
## Storage format
53-
(storage-format)=
53+
(version0.5:storage-format)=
5454

5555

5656
OME-Zarr is implemented using the Zarr format as defined by the
@@ -66,7 +66,7 @@ be stored on a web server to be accessed via HTTP or in object storage
6666
like S3 or GCS.
6767

6868
### Images
69-
(image-layout)=
69+
(version0.5:image-layout)=
7070

7171

7272
The following layout describes the expected Zarr hierarchy for images with
@@ -116,18 +116,18 @@ Note that the number of dimensions is variable between 2 and 5 and that axis nam
116116

117117

118118
### High-content screening
119-
(hcs-layout)=
119+
(version0.5:hcs-layout)=
120120

121121
The following specification defines the hierarchy for a high-content screening
122122
dataset. Three groups MUST be defined above the images:
123123

124124
- the group above the images defines the well and MUST implement the
125-
[well specification](#well-md). All images contained in a well are fields
125+
[well specification](#version0.5:well-md). All images contained in a well are fields
126126
of view of the same well
127127
- the group above the well defines a row of wells
128128
- the group above the well row defines an entire plate i.e. a two-dimensional
129129
collection of wells organized in rows and columns. It MUST implement the
130-
[plate specification](#plate-md)
130+
[plate specification](#version0.5:plate-md)
131131

132132
A well row group SHOULD NOT be present if there are no images in the well row.
133133
A well group SHOULD NOT be present if there are no images in the well.
@@ -156,7 +156,7 @@ A well group SHOULD NOT be present if there are no images in the well.
156156
</pre>
157157

158158
## OME-Zarr Metadata
159-
(metadata)=
159+
(version0.5:metadata)=
160160

161161
The "OME-Zarr Metadata" contains metadata keys as specified below
162162
for discovering certain types of data, especially images.
@@ -181,7 +181,7 @@ The OME-Zarr Metadata version MUST be consistent within a hierarchy.
181181
```
182182

183183
### "axes" metadata
184-
(axes-md)=
184+
(version0.5:axes-md)=
185185

186186
"axes" describes the dimensions of a physical coordinate space. It is a list of dictionaries, where each dictionary describes a dimension (axis) and:
187187
- MUST contain the field "name" that gives the name for this dimension. The values MUST be unique across all "name" fields.
@@ -190,13 +190,13 @@ The OME-Zarr Metadata version MUST be consistent within a hierarchy.
190190
- Units for "space" axes: 'angstrom', 'attometer', 'centimeter', 'decimeter', 'exameter', 'femtometer', 'foot', 'gigameter', 'hectometer', 'inch', 'kilometer', 'megameter', 'meter', 'micrometer', 'mile', 'millimeter', 'nanometer', 'parsec', 'petameter', 'picometer', 'terameter', 'yard', 'yoctometer', 'yottameter', 'zeptometer', 'zettameter'
191191
- Units for "time" axes: 'attosecond', 'centisecond', 'day', 'decisecond', 'exasecond', 'femtosecond', 'gigasecond', 'hectosecond', 'hour', 'kilosecond', 'megasecond', 'microsecond', 'millisecond', 'minute', 'nanosecond', 'petasecond', 'picosecond', 'second', 'terasecond', 'yoctosecond', 'yottasecond', 'zeptosecond', 'zettasecond'
192192

193-
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.
194194

195195
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.
196196

197197

198198
### "bioformats2raw.layout" (transitional)
199-
(bf2raw)=
199+
(version0.5:bf2raw)=
200200

201201
[=Transitional=] "bioformats2raw.layout" metadata identifies a group which implicitly describes a series of images.
202202
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
223223
</pre>
224224

225225
#### Attributes
226-
(bf2raw-attributes)=
226+
(version0.5:bf2raw-attributes)=
227227

228228
The OME-Zarr Metadata in the top-level `zarr.json` file must contain the `bioformats2raw.layout` key:
229229
<pre class=include-code>
@@ -248,7 +248,7 @@ highlight: json
248248
</pre>
249249

250250
#### Details
251-
(bf2raw-details)=
251+
(version0.5:bf2raw-details)=
252252

253253
Conforming groups:
254254

@@ -278,7 +278,7 @@ Conforming readers:
278278

279279

280280
### "coordinateTransformations" metadata
281-
(trafo-md)=
281+
(version0.5:trafo-md)=
282282

283283
"coordinateTransformations" describe a series of transformations that map between two coordinate spaces (defined by "axes").
284284
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.
298298

299299

300300
### "multiscales" metadata
301-
(multiscale-md)=
301+
(version0.5:multiscale-md)=
302302

303303
Metadata about an image can be found under the "multiscales" key in the group-level OME-Zarr Metadata.
304304
Here, image refers to 2 to 5 dimensional data representing image or volumetric data with optional time or channel axes.
305305
It is stored in a multiple resolution representation.
306306

307307
"multiscales" contains a list of dictionaries where each entry describes a multiscale image.
308308

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).
310310
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").
311311
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.
312312
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
318318

319319
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".
320320
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`.
322322
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.
323323
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.
324324
The length of the `scale` and `translation` array MUST be the same as the length of "axes".
@@ -354,7 +354,7 @@ if not datasets:
354354
```
355355

356356
### "omero" metadata (transitional)
357-
(omero-md)=
357+
(version0.5:omero-md)=
358358

359359
[=Transitional=] information specific to the channels of an image and how to render it
360360
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
395395
It MUST also contain the fields "start" and "end", which are the start and end values of the window, respectively.
396396

397397
### "labels" metadata
398-
(labels-md)=
398+
(version0.5:labels-md)=
399399

400400
In OME-Zarr, Zarr arrays representing pixel-annotation data are stored in a group called "labels". Some applications--notably image segmentation--produce
401401
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
463463
which correspond to cellular space, will be displayed as 50% green and 50% opacity.
464464

465465
### "plate" metadata
466-
(plate-md)=
466+
(version0.5:plate-md)=
467467

468468
For high-content screening datasets, the plate layout can be found under the
469469
custom attributes of the plate group under the `plate` key in the group-level metadata.
@@ -535,7 +535,7 @@ highlight: json
535535
</pre>
536536

537537
### "well" metadata
538-
(well-md)=
538+
(version0.5:well-md)=
539539

540540
For high-content screening datasets, the metadata about all fields of views
541541
under a given well can be found under the "well" key in the attributes of the
@@ -571,7 +571,7 @@ highlight: json
571571
</pre>
572572

573573
## Specification naming style
574-
(naming-style)=
574+
(version0.5:naming-style)=
575575

576576
Multi-word keys in this specification should use the `camelCase` style.
577577
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.
582582

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

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/).
592-
[(doi:10.5281/zenodo.4282107)](https://doi.org/10.5281/zenodo.4282107)
593-
594-
## Version History
595-
(history)=
596-
597-
<table>
598-
<thead>
599-
<tr>
600-
<td>Revision</td>
601-
<td>Date</td>
602-
<td>Description</td>
603-
</tr>
604-
</thead>
605-
<tr>
606-
<td>0.5.2</td>
607-
<td>2025-01-10</td>
608-
<td>Clarify that the <code>dimension_names</code> field in <code>axes</code> MUST be included.</td>
609-
</tr>
610-
<tr>
611-
<td>0.5.1</td>
612-
<td>2025-01-10</td>
613-
<td>Re-add the improved omero description in PR-191.</td>
614-
</tr>
615-
<tr>
616-
<td>0.5.0</td>
617-
<td>2024-11-21</td>
618-
<td>use Zarr v3 in OME-Zarr, see <a href="https://ngff.openmicroscopy.org/rfc/2">RFC-2</a>.</td>
619-
</tr>
620-
<tr>
621-
<td>0.4.1</td>
622-
<td>2023-02-09</td>
623-
<td>expand on "labels" description</td>
624-
</tr>
625-
<tr>
626-
<td>0.4.1</td>
627-
<td>2022-09-26</td>
628-
<td>transitional metadata for image collections ("bioformats2raw.layout")</td>
629-
</tr>
630-
<tr>
631-
<td>0.4.0</td>
632-
<td>2022-02-08</td>
633-
<td>multiscales: add axes type, units and coordinateTransformations</td>
634-
</tr>
635-
<tr>
636-
<td>0.4.0</td>
637-
<td>2022-02-08</td>
638-
<td>plate: add rowIndex/columnIndex </td>
639-
</tr>
640-
<tr>
641-
<td>0.3.0</td>
642-
<td>2021-08-24</td>
643-
<td>Add axes field to multiscale metadata </td>
644-
</tr>
645-
<tr>
646-
<td>0.2.0</td>
647-
<td>2021-03-29</td>
648-
<td>Change chunk dimension separator to "/" </td>
649-
</tr>
650-
<tr>
651-
<td>0.1.4</td>
652-
<td>2020-11-26</td>
653-
<td>Add HCS specification </td>
654-
</tr>
655-
<tr>
656-
<td>0.1.3</td>
657-
<td>2020-09-14</td>
658-
<td>Add labels specification </td>
659-
</tr>
660-
<tr>
661-
<td>0.1.2 </td>
662-
<td>2020-05-07</td>
663-
<td>Add description of "omero" metadata </td>
664-
</tr>
665-
<tr>
666-
<td>0.1.1 </td>
667-
<td>2020-05-06</td>
668-
<td>Add info on the ordering of resolutions </td>
669-
</tr>
670-
<tr>
671-
<td>0.1.0 </td>
672-
<td>2020-04-20</td>
673-
<td>First version for internal demo </td>
674-
</tr>
675-
</table>
676-
677-
678585
<pre class="biblio">
679586
{
680587
"blogNov2020": {

version_history.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,6 @@ All notable changes to this project will be documented in this file.
88

99
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
1010

11-
## [0.6.dev2] - 2025-12-02
12-
13-
### Changed
14-
15-
Implemented feedback from [RFC-5 review 1 and 2](https://ngff.openmicroscopy.org/rfc/5/reviews/index.html)
16-
17-
## [0.6dev1] - 2025-11-18
18-
19-
### Added
20-
21-
Initial proposal for RFC-5: Transforms. [See proposal text](https://ngff.openmicroscopy.org/rfc/5/versions/1/index.html).
22-
2311
## [0.5.2] - 2025-01-10
2412

2513
### Changed

0 commit comments

Comments
 (0)