You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contribute.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -167,6 +167,6 @@ Before creating a release, please make sure to go through the following items to
167
167
168
168
-[ ] Update `_version.py`. Some internal code requires a version number to be provided there to auto-generate some parts of the documentation.
169
169
-[ ] 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.
171
171
-[ ] 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.
Copy file name to clipboardExpand all lines: index.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -153,7 +153,7 @@ those Zarr arrays SHOULD be stored in a Zarr group on the same level as images c
153
153
store.zarr # One scene dataset
154
154
│
155
155
├── 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.
157
157
│ # I.e., transformations between coordinate systems in the 'volume' and 'crop' multiscale images are stored here.
158
158
│
159
159
├── 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:
520
520
|[`displacements`](#coordinates-displacements-md)|`"path":str`| Displacement field transformation located at `path`. |
521
521
|[`coordinates`](#coordinates-displacements-md)|`"path":str`| Coordinate field transformation located at `path`. |
522
522
|[`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. |
524
524
525
525
Implementations SHOULD prefer to store transformations as a sequence of less expressive transformations where possible
526
526
(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
574
574
The output can be another coordinate system defined under `multiscales > coordinateSystems`.
575
575
576
576
-**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
579
579
that refer to coordinate systems in the same zarr.json or in the metadata of multiscale image subgroups.
580
580
581
581
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
1201
1201
using lower dimensional transformations on subsets of dimensions.
1202
1202
1203
1203
**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`.
1206
1206
The values of `input_axes` and `output_axes` are arrays of integers.
1207
1207
The integer values in these arrays correspond to the axis indices in the `byDimension`'s or its parent's
1208
1208
`input` and `output` coordinate systems, respectively.
@@ -1567,7 +1567,7 @@ and MUST NOT be a duplicate of any other `name` in the `rows` array.
1567
1567
Care SHOULD be taken to avoid collisions on case-insensitive filesystems
1568
1568
(e.g. avoid using both `Aa` and `aA`).
1569
1569
1570
-
The `plate`dictionary MUST contain a `wells` key
1570
+
The `plate`object MUST contain a `wells` key
1571
1571
whose value MUST be a list of JSON objects defining the wells of the plate.
1572
1572
Each well object MUST contain a `path` key
1573
1573
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
1641
1641
For images that share a spatial relationship,
1642
1642
the `scene` metadata layout can be used to describe the relationship between images.
1643
1643
1644
-
The `scene`dictionary MUST contain the field `coordinateTransformations`,
1644
+
The `scene`object MUST contain the field `coordinateTransformations`,
1645
1645
whose value MUST be an array of valid [transformations](#trafo-types-md).
1646
1646
It MAY contain the field `coordinateSystems`,
1647
1647
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`.
1651
1651
1652
1652
**name**
1653
1653
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.
1655
1655
1656
1656
**path**
1657
1657
Refers to the path of a multiscale image subgroup in the Zarr hierarchy.
1658
1658
1659
-
If `name` refers to a coordinate system in the `scene`dictionary,
1659
+
If `name` refers to a coordinate system in the `scene`object,
1660
1660
the `path` value MAY be omitted or null.
1661
1661
If `name` refers to a coordinate system in the multiscale image subgroup specified by `path`,
0 commit comments