Skip to content

Commit

Permalink
Merge pull request #242 from normanrz/spec-rfc2
Browse files Browse the repository at this point in the history
Changes to the spec and schemata for RFC-2
  • Loading branch information
joshmoore authored Nov 22, 2024
2 parents e1dc738 + d3e1fb8 commit 3fc518b
Show file tree
Hide file tree
Showing 83 changed files with 3,842 additions and 3,753 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
jobs:
main:
name: Build, Validate and Deploy
runs-on: ubuntu-20.04
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v2
- uses: ome/spec-prod@main
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ jobs:
- '0.2'
- '0.3'
- '0.4'
- '0.5'
- 'latest'
runs-on: ubuntu-20.04
steps:
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2

build:
os: ubuntu-22.04
os: ubuntu-24.04
tools:
python: "3.10"

Expand Down
5 changes: 2 additions & 3 deletions 0.1/index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ Title: Next-generation file formats (NGFF)
Shortname: ome-ngff
Level: 1
Status: w3c/CG-FINAL
Group: ome
TR: https://ngff.openmicroscopy.org/0.1/
URL: https://ngff.openmicroscopy.org/0.1/
Repository: https://github.com/ome/ngff
Issue Tracking: Forums https://forum.image.sc/tag/ome-ngff
Logo: http://www.openmicroscopy.org/img/logos/ome-logomark.svg
Local Boilerplate: header yes
Local Boilerplate: copyright yes
Local Boilerplate: header yes, copyright yes
Boilerplate: style-darkmode off
Markup Shorthands: markdown yes
Editor: Josh Moore, Open Microscopy Environment (OME) https://www.openmicroscopy.org
Expand Down
5 changes: 2 additions & 3 deletions 0.2/index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ Title: Next-generation file formats (NGFF)
Shortname: ome-ngff
Level: 1
Status: w3c/CG-FINAL
Group: ome
TR: https://ngff.openmicroscopy.org/0.2/
URL: https://ngff.openmicroscopy.org/0.2/
Repository: https://github.com/ome/ngff
Issue Tracking: Forums https://forum.image.sc/tag/ome-ngff
Logo: http://www.openmicroscopy.org/img/logos/ome-logomark.svg
Local Boilerplate: header yes
Local Boilerplate: copyright yes
Local Boilerplate: header yes, copyright yes
Boilerplate: style-darkmode off
Markup Shorthands: markdown yes
Editor: Josh Moore, Open Microscopy Environment (OME) https://www.openmicroscopy.org
Expand Down
File renamed without changes.
5 changes: 2 additions & 3 deletions 0.3/index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ Title: Next-generation file formats (NGFF)
Shortname: ome-ngff
Level: 1
Status: w3c/CG-FINAL
Group: ome
TR: https://ngff.openmicroscopy.org/0.3/
URL: https://ngff.openmicroscopy.org/0.3/
Repository: https://github.com/ome/ngff
Issue Tracking: Forums https://forum.image.sc/tag/ome-ngff
Logo: http://www.openmicroscopy.org/img/logos/ome-logomark.svg
Local Boilerplate: header yes
Local Boilerplate: copyright yes
Local Boilerplate: header yes, copyright yes
Boilerplate: style-darkmode off
Markup Shorthands: markdown yes
Editor: Josh Moore, Open Microscopy Environment (OME) https://www.openmicroscopy.org
Expand Down
34 changes: 34 additions & 0 deletions 0.4/header.include
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>[TITLE]</title>
<style data-fill-with="stylesheet">
</style>
</head>
<body class="h-entry">
<div class="head">

<!--p data-fill-with="logo"></p-->
<img src="https://www.openmicroscopy.org/img/logos/ome-logomark.svg"
alt="OME logo (6 circles in a hexagon)"
style="float:right;width:42px;height:42px;">

<h1 id="title" class="p-name no-ref">[TITLE]</h1>
<h2 id="subtitle" class="no-num no-toc no-ref">[LONGSTATUS],
<time class="dt-updated" datetime="[ISODATE]">[DATE]</time></h2>
<div data-fill-with="spec-metadata"></div>
<div data-fill-with="warning"></div>
<p class='copyright' data-fill-with='copyright'></p>
<hr title="Separator for header">
</div>

<div class="p-summary" data-fill-with="abstract"></div>

<h2 class='no-num no-toc no-ref' id='sotd'>Status of this document</h2>
<div data-fill-with="status"></div>
<div data-fill-with="at-risk"></div>

<nav data-fill-with="table-of-contents" id="toc"></nav>
<main>
8 changes: 3 additions & 5 deletions 0.4/index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@
Title: Next-generation file formats (NGFF)
Shortname: ome-ngff
Level: 1
Status: LS-COMMIT
Status: w3c/CG-FINAL
Group: ome
TR: https://ngff.openmicroscopy.org/0.4/
URL: https://ngff.openmicroscopy.org/0.4/
Repository: https://github.com/ome/ngff
Issue Tracking: Forums https://forum.image.sc/tag/ome-ngff
Logo: http://www.openmicroscopy.org/img/logos/ome-logomark.svg
Local Boilerplate: header yes
Local Boilerplate: copyright yes
Local Boilerplate: header yes, copyright yes
Boilerplate: style-darkmode off
Markup Shorthands: markdown yes
Editor: Josh Moore, University of Dundee (UoD) https://www.dundee.ac.uk, https://orcid.org/0000-0003-4028-811X
Expand Down Expand Up @@ -241,7 +239,7 @@ keys as specified below for discovering certain types of data, especially images

"axes" describes the dimensions of a physical coordinate space. It is a list of dictionaries, where each dictionary describes a dimension (axis) and:
- MUST contain the field "name" that gives the name for this dimension. The values MUST be unique across all "name" fields.
- SHOULD contain the field "type". It SHOULD be one of "space", "time" or "channel", but MAY take other values for custom axis types that are not part of this specification yet.
- SHOULD contain the field "type". It SHOULD be one of "space", "time" or "channel", but MAY take other string values for custom axis types that are not part of this specification yet.
- SHOULD contain the field "unit" to specify the physical unit of this dimension. The value SHOULD be one of the following strings, which are valid units according to UDUNITS-2.
- 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'
- 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'
Expand Down
File renamed without changes.
File renamed without changes.
10 changes: 10 additions & 0 deletions 0.5/examples/bf2raw/image.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"zarr_format": 3,
"node_type": "group",
"attributes": {
"ome": {
"version": "0.5",
"bioformats2raw.layout": 3
}
}
}
36 changes: 36 additions & 0 deletions 0.5/examples/bf2raw/plate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"zarr_format": 3,
"node_type": "group",
"attributes": {
"ome": {
"version": "0.5",
"bioformats2raw.layout": 3,
"plate": {
"columns": [
{
"name": "1"
}
],
"name": "Plate Name 0",
"wells": [
{
"path": "A/1",
"rowIndex": 0,
"columnIndex": 0
}
],
"field_count": 1,
"rows": [
{
"name": "A"
}
],
"acquisitions": [
{
"id": 0
}
]
}
}
}
}
File renamed without changes.
37 changes: 37 additions & 0 deletions 0.5/examples/label_strict/colors_properties.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"zarr_format": 3,
"node_type": "group",
"attributes": {
"ome": {
"version": "0.5",
"image-label": {
"colors": [
{
"label-value": 0,
"rgba": [0, 0, 128, 128]
},
{
"label-value": 1,
"rgba": [0, 128, 0, 128]
}
],
"properties": [
{
"label-value": 0,
"area (pixels)": 1200,
"class": "intercellular space"
},
{
"label-value": 1,
"area (pixels)": 1650,
"class": "cell",
"cell type": "neuron"
}
],
"source": {
"image": "../../"
}
}
}
}
}
68 changes: 68 additions & 0 deletions 0.5/examples/multiscales_strict/multiscales_example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
{
"zarr_format": 3,
"node_type": "group",
"attributes": {
"ome": {
"version": "0.5",
"multiscales": [
{
"name": "example",
"axes": [
{ "name": "t", "type": "time", "unit": "millisecond" },
{ "name": "c", "type": "channel" },
{ "name": "z", "type": "space", "unit": "micrometer" },
{ "name": "y", "type": "space", "unit": "micrometer" },
{ "name": "x", "type": "space", "unit": "micrometer" }
],
"datasets": [
{
"path": "0",
"coordinateTransformations": [
{
// the voxel size for the first scale level (0.5 micrometer)
"type": "scale",
"scale": [1.0, 1.0, 0.5, 0.5, 0.5]
}
]
},
{
"path": "1",
"coordinateTransformations": [
{
// the voxel size for the second scale level (downscaled by a factor of 2 -> 1 micrometer)
"type": "scale",
"scale": [1.0, 1.0, 1.0, 1.0, 1.0]
}
]
},
{
"path": "2",
"coordinateTransformations": [
{
// the voxel size for the third scale level (downscaled by a factor of 4 -> 2 micrometer)
"type": "scale",
"scale": [1.0, 1.0, 2.0, 2.0, 2.0]
}
]
}
],
"coordinateTransformations": [
{
// the time unit (0.1 milliseconds), which is the same for each scale level
"type": "scale",
"scale": [0.1, 1.0, 1.0, 1.0, 1.0]
}
],
"type": "gaussian",
"metadata": {
"description": "the fields in metadata depend on the downscaling implementation. Here, the parameters passed to the skimage function are given",
"method": "skimage.transform.pyramid_gaussian",
"version": "0.16.1",
"args": "[true]",
"kwargs": { "multichannel": true }
}
}
]
}
}
}
47 changes: 47 additions & 0 deletions 0.5/examples/multiscales_strict/multiscales_transformations.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"zarr_format": 3,
"node_type": "group",
"attributes": {
"ome": {
"version": "0.5",
"multiscales": [
{
"axes": [
{
"name": "y",
"type": "space",
"unit": "micrometer"
},
{
"name": "x",
"type": "space",
"unit": "micrometer"
}
],
"datasets": [
{
"path": "0",
"coordinateTransformations": [
{
"scale": [1, 1],
"type": "scale"
}
]
}
],
"coordinateTransformations": [
{
"scale": [10, 10],
"type": "scale"
}
],
"name": "image_with_coordinateTransformations",
"type": "foo",
"metadata": {
"key": "value"
}
}
]
}
}
}
File renamed without changes.
10 changes: 10 additions & 0 deletions 0.5/examples/ome/series-2.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"zarr_format": 3,
"node_type": "group",
"attributes": {
"ome": {
"version": "0.5",
"series": ["0", "1"]
}
}
}
File renamed without changes.
Loading

0 comments on commit 3fc518b

Please sign in to comment.