Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unit -> units #168

Closed
wants to merge 11 commits into from
Closed

unit -> units #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d7a616a
unit -> units
d-v-b Mar 1, 2023
1e6b48e
Fix 'units' -> 'unit' in 0.4 and latest schemas, examples and test files
will-moore Nov 2, 2022
5a26ac8
change unit to units in schema
d-v-b Mar 10, 2023
38f2d80
change unit to units in examples
d-v-b Mar 10, 2023
4f5049e
Fix `<img/>` element for newer bikeshed versions
joshmoore Mar 14, 2023
1a74291
Fix `<img/>` element for newer bikeshed versions
joshmoore Mar 14, 2023
859a5c8
clarify relationship between units and old unit key
d-v-b Mar 17, 2023
9a10f41
Merge branch 'main' into units
d-v-b Mar 17, 2023
815d9a4
style
d-v-b Mar 18, 2023
5a59d3f
add units to schema
d-v-b Mar 21, 2023
e3bba84
style tweaks
d-v-b Mar 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions 0.1/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,8 +501,7 @@ Projects which support reading and/or writing OME-NGFF data include:

</dl>

<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png"
alt="Diagram of related projects"/>
<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png" alt="Diagram of related projects"></img>

All implementations prevent an equivalent representation of a dataset which can be downloaded or uploaded freely. An interactive
version of this diagram is available from the [OME2020 Workshop](https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/).
Expand Down
3 changes: 1 addition & 2 deletions 0.2/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,8 +559,7 @@ Projects which support reading and/or writing OME-NGFF data include:

</dl>

<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png"
alt="Diagram of related projects"/>
<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png" alt="Diagram of related projects"></img>

All implementations prevent an equivalent representation of a dataset which can be downloaded or uploaded freely. An interactive
version of this diagram is available from the [OME2020 Workshop](https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/).
Expand Down
3 changes: 1 addition & 2 deletions 0.3/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,8 +569,7 @@ Projects which support reading and/or writing OME-NGFF data include:

</dl>

<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png"
alt="Diagram of related projects"/>
<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png" alt="Diagram of related projects"></img>

All implementations prevent an equivalent representation of a dataset which can be downloaded or uploaded freely. An interactive
version of this diagram is available from the [OME2020 Workshop](https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/).
Expand Down
3 changes: 1 addition & 2 deletions 0.4/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,8 +639,7 @@ Projects which support reading and/or writing OME-NGFF data include:

</dl>

<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png"
alt="Diagram of related projects"/>
<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png" alt="Diagram of related projects"></img>

All implementations prevent an equivalent representation of a dataset which can be downloaded or uploaded freely. An interactive
version of this diagram is available from the [OME2020 Workshop](https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/).
Expand Down
10 changes: 5 additions & 5 deletions latest/examples/multiscales_strict/multiscales_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
"version": "0.5-dev",
"name": "example",
"axes": [
{"name": "t", "type": "time", "unit": "millisecond"},
{"name": "t", "type": "time", "units": "millisecond"},
{"name": "c", "type": "channel"},
{"name": "z", "type": "space", "unit": "micrometer"},
{"name": "y", "type": "space", "unit": "micrometer"},
{"name": "x", "type": "space", "unit": "micrometer"}
{"name": "z", "type": "space", "units": "micrometer"},
{"name": "y", "type": "space", "units": "micrometer"},
{"name": "x", "type": "space", "units": "micrometer"}
],
"datasets": [
{
Expand Down Expand Up @@ -37,7 +37,7 @@
}
],
"coordinateTransformations": [{
// the time unit (0.1 milliseconds), which is the same for each scale level
// the time units (0.1 milliseconds), which is the same for each scale level
"type": "scale",
"scale": [0.1, 1.0, 1.0, 1.0, 1.0]
}],
Expand Down
14 changes: 9 additions & 5 deletions latest/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,14 @@ 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 "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.
- MUST contain the field "name" that gives the name for this dimension. The value MUST be a string. The values MUST be unique across all "name" fields.
- SHOULD contain the field "type". It SHOULD be one of strings "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 "units" to specify the physical units associated with this dimension. Previous versions of the specification used the name "unit" for this field. For backwards compatibility,
the field "unit" is permitted, but this usage will not be supported by future versions of the specification. If both "units" and "unit" fields are present, the value associated with "units" should be used.

Implementation note: wherever possible, applications implementing this specification SHOULD issue a deprecation warning if the "unit" field is present on any elements of "axes". Users should be notified that the "unit" field is being deprecated and replaced by "units".

The value of "units" 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 Expand Up @@ -648,8 +653,7 @@ Projects which support reading and/or writing OME-NGFF data include:

</dl>

<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png"
alt="Diagram of related projects"/>
<img src="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/images/zarr-ome-diagram.png" alt="Diagram of related projects"></img>

All implementations prevent an equivalent representation of a dataset which can be downloaded or uploaded freely. An interactive
version of this diagram is available from the [OME2020 Workshop](https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/).
Expand Down
3 changes: 3 additions & 0 deletions latest/schemas/image.schema
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@
},
"unit": {
"type": "string"
},
"units": {
"type": "string"
}
}
},
Expand Down