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

Jump to bottom

Clarify version field #210

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Clarify version field #210

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3a92e1
docs: clarify that the field is a string, and it must be the current…
d-v-b Aug 1, 2023
5398073
style: add quotation marks around version string
d-v-b Aug 1, 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
13 changes: 7 additions & 6 deletions latest/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,10 +326,13 @@ Each "multiscales" dictionary MAY contain the field "coordinateTransformations",
The transformations MUST follow the same rules about allowed types, order, etc. as in "datasets:coordinateTransformations" and are applied after them.
They can for example be used to specify the `scale` for a dimension that is the same for all resolutions.

Each "multiscales" dictionary SHOULD contain the field "name". It MUST contain the field "version", which indicates the version of the multiscale metadata of this image (current version is [NGFFVERSION]).
Each "multiscales" dictionary SHOULD contain the field "name".

Each "multiscales" dictionary MUST contain the field "version", which is the string "[NGFFVERSION]".

Each "multiscales" dictionary SHOULD contain the field "type", which gives the type of downscaling method used to generate the multiscale image pyramid.
It SHOULD contain the field "metadata", which contains a dictionary with additional information about the downscaling method.

Each "multiscales" dictionary SHOULD contain the field "metadata", which contains a dictionary with additional information about the downscaling method.

<pre class=include-code>
path: examples/multiscales_strict/multiscales_example.json
Expand Down Expand Up @@ -492,8 +495,7 @@ contain only alphanumeric characters, MUST be case-sensitive, and MUST NOT be a
other `name` in the `rows` list. Care SHOULD be taken to avoid collisions on
case-insensitive filesystems (e.g. avoid using both `Aa` and `aA`).

The `plate` dictionary MUST contain a `version` key whose value MUST be a string specifying the
version of the plate specification.
The `plate` dictionary MUST contain a `version` key whose value MUST be the string "[NGFFVERSION]".

The `plate` dictionary MUST contain a `wells` key whose value MUST be a list of JSON objects
defining the wells of the plate. Each well object MUST contain a `path` key whose value MUST
Expand Down Expand Up @@ -536,8 +538,7 @@ of any other `path` in the `images` list. If multiple acquisitions were performe
it MUST contain an `acquisition` key whose value MUST be an integer identifying the acquisition
which MUST match one of the acquisition JSON objects defined in the plate metadata (see #plate-md).

The `well` dictionary SHOULD contain a `version` key whose value MUST be a string specifying the
version of the well specification.
The `well` dictionary SHOULD contain a `version` key whose value MUST the string "[NGFFVERSION]".

For example the following JSON object defines a well with four fields of
view. The first two fields of view were part of the first acquisition while
Expand Down