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] Add coil entity for uncombined MR data #425

Closed
wants to merge 21 commits into from
Closed
Show file tree
Hide file tree
Changes from 17 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
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ by Ben Inglis:
"RECOMMENDED",
"See an example below the table.",
),
"CoilString": "RECOMMENDED",
"GradientSetType": "RECOMMENDED",
"MRTransmitCoilSequence": "RECOMMENDED",
"MatrixCoilMode": "RECOMMENDED",
Expand Down Expand Up @@ -246,6 +247,12 @@ sequences using different contrast enhanced images. The label is the name of the
contrast agent. The key `ContrastBolusIngredient` MAY be also be added in the
JSON file, with the same label.

The OPTIONAL [`coil-<label>`](../99-appendices/09-entities.md#coil) key/value can be used to distinguish coil-specific data.
Typically it is used for sequences not employing coil combination (for example, SWI).
When the file contains data from a single coil, `coil-<label>` SHOULD be provided.
The key `CoilString` MAY also be added in the JSON file, with a corresponding
tsalo marked this conversation as resolved.
Show resolved Hide resolved
identifier for the coil.

Some meta information about the acquisition MAY be provided in an additional
JSON file. See [Common metadata fields](#common-metadata-fields) for a
list of terms and their definitions. There are also some OPTIONAL JSON
Expand Down Expand Up @@ -404,6 +411,11 @@ reconstruction algorithms (for example ones using motion correction).
See [`fmap` Case 4](01-magnetic-resonance-imaging-data.md#case-4-multiple-phase-encoded-directions-pepolar)
for more information on `dir` field specification.

Similarly the OPTIONAL [`coil-<label>`](../99-appendices/09-entities.md#coil) key/value can be used to distinguish
coil-specific data from sequences not employing coil combination.
The key `CoilString` MAY also be added in the JSON file, with a corresponding
coil identifier.

Multi-echo data MUST be split into one file per echo using the
[`echo-<index>`](../99-appendices/09-entities.md#echo) key-value pair. For example:

Expand Down
1 change: 1 addition & 0 deletions src/schema/datatypes/anat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
ceagent: optional
reconstruction: optional
part: optional
coil: optional
# Parametric
- suffixes:
- T1map
Expand Down
1 change: 1 addition & 0 deletions src/schema/datatypes/func.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
run: optional
echo: optional
part: optional
coil: optional
# Phase (deprecated)
- suffixes:
- phase # deprecated
Expand Down
10 changes: 10 additions & 0 deletions src/schema/entities.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,16 @@ part:
When there is only a magnitude image of a given type, the `part` key MAY be
omitted.
format: label
coil:
name: Coil
entity: coil
description: |
The `coil-<label>` key/value can be used to distinguish coil-specific data.
Typically it is used for sequences not employing coil combination (for example, SWI).
When the file contains data from a single coil, `coil-<label>` SHOULD be provided.
The key `CoilString` MAY also be added in the JSON file, with a
corresponding identifier for the coil.
format: label
recording:
name: Recording
entity: recording
Expand Down