Skip to content

Commit 18293c5

Browse files
authored
Merge branch 'main' into no-separate-field-for-arrayCoordinateSystem
2 parents 00a9233 + 6ad27fe commit 18293c5

3 files changed

Lines changed: 13 additions & 17 deletions

File tree

contribute.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,6 @@ Before creating a release, please make sure to go through the following items to
167167

168168
- [ ] Update `_version.py`. Some internal code requires a version number to be provided there to auto-generate some parts of the documentation.
169169
- [ ] Update versions in examples. Go through the examples in the `examples/` and make sure that all version numbers in the `.json` files are up-to-date.
170-
- [ ] Update the specification number in the spec text. The [spec text](ngff-spec:spec) mentions its own version number in several places. Please make sure to update those to the new version.
170+
- [ ] Update the specification number in the spec text. The [spec text](./index.md) mentions its own version number in several places. Please make sure to update those to the new version.
171171
- [ ] Make sure all tests are passing. Run the test suite to make sure that all tests are passing before creating a release.
172-
- [ ] Update the version history. Add a new entry to the [version history](ngff-spec:history) file with the new version number and date, and a summary of the changes made in this release.
172+
- [ ] Update the version history. Add a new entry to the [version history](#ngff-spec:history) file with the new version number and date, and a summary of the changes made in this release.

index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ those Zarr arrays SHOULD be stored in a Zarr group on the same level as images c
153153
store.zarr # One scene dataset
154154
155155
├── zarr.json # coordinate transformations describing the relationship between two image coordinate systems
156-
│ # are stored in the "scene" dictionary here.
156+
│ # are stored in the "scene" object here.
157157
│ # I.e., transformations between coordinate systems in the 'volume' and 'crop' multiscale images are stored here.
158158
159159
├── coordinateTransformations # transformations that use array storage for their parameters should go in a Zarr group named "coordinateTransformations".
@@ -520,7 +520,7 @@ The following transformations are supported:
520520
| [`displacements`](#coordinates-displacements-md) | `"path":str` | Displacement field transformation located at `path`. |
521521
| [`coordinates`](#coordinates-displacements-md) | `"path":str` | Coordinate field transformation located at `path`. |
522522
| [`bijection`](#bijection-md) | `"forward":Transformation`<br>`"inverse":Transformation` | An invertible transformation providing an explicit forward transformation and its inverse. |
523-
| [`byDimension`](#bydimension-md) | `"transformations":List[Transformation]`, <br> `"input_axes": List[str]`, <br> `"output_axes": List[str]` | A high dimensional transformation using lower dimensional transformations on subsets of dimensions. |
523+
| [`byDimension`](#bydimension-md) | `"transformations":List[Transformation]`.<br>Transformations in the array MUST have<br>`"input_axes": List[number]`, <br> and `"output_axes": List[number]` | A high dimensional transformation using lower dimensional transformations on subsets of dimensions. |
524524

525525
Implementations SHOULD prefer to store transformations as a sequence of less expressive transformations where possible
526526
(e.g., sequence[translation, rotation], instead of affine transformation with translation/rotation).
@@ -574,8 +574,8 @@ Coordinate transformations can be stored in multiple places to reflect different
574574
The output can be another coordinate system defined under `multiscales > coordinateSystems`.
575575

576576
- **Inside `scene > coordinateTransformations`**: Transformations between two or more images
577-
MUST be stored in the attributes of a [`scene` dictionary](#scene-md) in a [scene Zarr group](#scene-format).
578-
In this case, the `input` and `output` values are dictionaries
577+
MUST be stored in the attributes of a [`scene` object](#scene-md) in a [scene Zarr group](#scene-format).
578+
In this case, the `input` and `output` values are objects
579579
that refer to coordinate systems in the same zarr.json or in the metadata of multiscale image subgroups.
580580

581581
This separation of transformations (inside `multiscales > datasets`, under `multiscales > coordinateTransformations` and under `scene > coordinateTransformations`) provides flexibility for different use cases while still maintaining a level of rigidity for implementations.
@@ -1201,8 +1201,8 @@ I.e. the y-displacement is first, because the y-axis is the first element of the
12011201
using lower dimensional transformations on subsets of dimensions.
12021202

12031203
**transformations**
1204-
: MUST be an array of wrapped transformations.
1205-
Each item MUST contain `input_axes`, `output_axes` and `transformation` fields.
1204+
: MUST be an array of objects where each object MUST contain
1205+
the fields `input_axes`, `output_axes` and `transformation`.
12061206
The values of `input_axes` and `output_axes` are arrays of integers.
12071207
The integer values in these arrays correspond to the axis indices in the `byDimension`'s or its parent's
12081208
`input` and `output` coordinate systems, respectively.
@@ -1567,7 +1567,7 @@ and MUST NOT be a duplicate of any other `name` in the `rows` array.
15671567
Care SHOULD be taken to avoid collisions on case-insensitive filesystems
15681568
(e.g. avoid using both `Aa` and `aA`).
15691569

1570-
The `plate` dictionary MUST contain a `wells` key
1570+
The `plate` object MUST contain a `wells` key
15711571
whose value MUST be a list of JSON objects defining the wells of the plate.
15721572
Each well object MUST contain a `path` key
15731573
whose value MUST be a string specifying the path to the well subgroup.
@@ -1641,7 +1641,7 @@ The first field is part of the first acquisition, and the second field is part o
16411641
For images that share a spatial relationship,
16421642
the `scene` metadata layout can be used to describe the relationship between images.
16431643

1644-
The `scene` dictionary MUST contain the field `coordinateTransformations`,
1644+
The `scene` object MUST contain the field `coordinateTransformations`,
16451645
whose value MUST be an array of valid [transformations](#trafo-types-md).
16461646
It MAY contain the field `coordinateSystems`,
16471647
whose values MUST be an array of valid [coordinate systems](#coordinate-systems-md).
@@ -1651,12 +1651,12 @@ which MUST contain the field `name` and MAY contain the field `path`.
16511651

16521652
**name**
16531653
Refers to the name of a `coordinateSystem` either in the multiscale image subgroup specified by the path,
1654-
or within the `scene` dictionary itself.
1654+
or within the `scene` object itself.
16551655

16561656
**path**
16571657
Refers to the path of a multiscale image subgroup in the Zarr hierarchy.
16581658

1659-
If `name` refers to a coordinate system in the `scene` dictionary,
1659+
If `name` refers to a coordinate system in the `scene` object,
16601660
the `path` value MAY be omitted or null.
16611661
If `name` refers to a coordinate system in the multiscale image subgroup specified by `path`,
16621662
both `path` and `name` MUST be provided.

schemas/strict_well.schema

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
{
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
33
"$id": "https://ngff.openmicroscopy.org/0.6.dev3/schemas/strict_well.schema",
4-
"allOf": [
5-
{
6-
"$ref": "https://ngff.openmicroscopy.org/0.6.dev3/schemas/well.schema"
7-
}
8-
]
4+
"$ref": "https://ngff.openmicroscopy.org/0.6.dev3/schemas/well.schema"
95
}

0 commit comments

Comments
 (0)