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.

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

[ENH] Specify echo and run indices are nonnegative integers in schema #578

Merged
merged 3 commits into from
Aug 24, 2020
Merged
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions src/schema/entities.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,9 @@ run:
name: Run
description: |
If several scans of the same modality are acquired they MUST be indexed
with a key-value pair: `_run-1`, `_run-2`, `_run-3` etc. (only integers
are allowed as run labels).
with a key-value pair: `_run-1`, `_run-2`, ..., `_run-<index>`
(only nonnegative integers are allowed for the `<index>`).
When there is only one scan of a given type the run key MAY be omitted.
Please note that diffusion imaging data is stored elsewhere (see below).
format: index
mod:
name: Corresponding Modality
Expand All @@ -93,6 +92,9 @@ echo:
Multi-echo data MUST be split into one file per echo.
Each file shares the same name with the exception of the `_echo-<index>`
key/value.
Please note that the `<index>` denotes the number/index (in the form of a
nonnegative integer) of the echo not the echo time value which needs to be
stored in the field `EchoTime` of the separate JSON file.
format: index
recording:
name: Recording
Expand Down