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 the naming of scanner-generated TRACE and ADC volumes #1725

Merged
merged 7 commits into from
May 22, 2024
Merged
26 changes: 19 additions & 7 deletions src/modality-specific-files/magnetic-resonance-imaging-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,13 +656,18 @@ The definitions of these fields can be found in
and a guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___make_suffix_table(
[
"dwi",
"sbref",
]
)
}}
{{ MACROS___make_suffix_table(["dwi", "sbref"]) }}

Additionally, the following suffixes are used for scanner-generated images:

<!--
This block generates a suffix table.
The definitions of these fields can be found in
src/schema/rules/files/raw
and a guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___make_suffix_table(["ADC", "TRACE"]) }}

<!--
This block generates a filename templates.
Expand Down Expand Up @@ -691,6 +696,13 @@ In such a case, two files could have the following names:
The user is free to choose any other label than `singleband` and
`multiband`, as long as they are consistent across subjects and sessions.

Scanner-generated TRACE and ADC volumes MAY be included using the
`TRACE` and `ADC` suffixes.
If TRACE or ADC volume filenames match a diffusion series with all applicable entities,
such volumes SHOULD be computed from that series.
Otherwise, some entity, such as [`acq-<label>`](../appendices/entities.md#acq),
SHOULD be used to indicate that the files are unrelated.

### REQUIRED gradient orientation information

The REQUIRED gradient orientation information corresponding to a DWI acquisition
Expand Down
10 changes: 10 additions & 0 deletions src/schema/objects/suffixes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ TwoPE:
display_name: 2-photon excitation microscopy
description: |
2-photon excitation microscopy imaging data
ADC:
value: ADC
display_name: Apparent diffusion coefficient (ADC)
description:
Apparent diffusion coefficient (ADC) map
BF:
value: BF
display_name: Bright-field microscopy
Expand Down Expand Up @@ -460,6 +465,11 @@ TEM:
display_name: Transmission electron microscopy
description: |
Transmission electron microscopy imaging data
TRACE:
value: TRACE
display_name: Trace diffusion weighted image
description: |
Diffusion images proportional to the trace of the diffusion tensor
UNIT1:
value: UNIT1
display_name: Homogeneous (flat) T1-weighted MP2RAGE image
Expand Down
9 changes: 9 additions & 0 deletions src/schema/rules/files/deriv/imaging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ dwi_volumetric:
density: optional
description: optional

dwi_isotropic:
$ref: rules.files.raw.dwi.isotropic
entities:
$ref: rules.files.raw.dwi.isotropic.entities
space: optional
resolution: optional
density: optional
description: optional

func_volumetric:
$ref: rules.files.raw.func.func
entities:
Expand Down
20 changes: 20 additions & 0 deletions src/schema/rules/files/raw/dwi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,23 @@ sbref:
run: optional
part: optional
chunk: optional

# Common scanner-generated derivatives need raw names
isotropic:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a comment here summarizing what this group is?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah looks good ! thx @remi pointing to the rendered version :-)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scanner-derived images won't be isotropic if the DWI acquisition wasn't isotropic. Elsewhere in this file I see "parametric" vs. "nonparametric"; I wonder if that's the more suitable disambiguation here? Otherwise may need to adopt "scanner-derived" (comment in #1831).

suffixes:
- ADC
- TRACE
extensions:
- .nii.gz
- .nii
- .json
datatypes:
- dwi
entities:
subject: required
session: optional
acquisition: optional
reconstruction: optional
direction: optional
run: optional
chunk: optional
Loading