Skip to content

Commit

Permalink
Changes to scanner-generated DWI derivatives
Browse files Browse the repository at this point in the history
- Rename "TRACE" suffix to "trace".
- Add "exponentiated ADC" measure.
- Fix description of trace-weighted image, resolving #1862.
- Modify descriptions of FA and colFA.
- Fix alphabetic sorting of suffices.
  • Loading branch information
Lestropie committed Jun 27, 2024
1 parent 5cabca0 commit 04a96f5
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 20 deletions.
10 changes: 5 additions & 5 deletions src/modality-specific-files/magnetic-resonance-imaging-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -667,7 +667,7 @@ 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(["ADC", "TRACE", "FA", "colFA"]) }}
{{ MACROS___make_suffix_table(["ADC", "expADC", "trace", "FA", "colFA"]) }}

<!--
This block generates a filename templates.
Expand Down Expand Up @@ -696,10 +696,10 @@ 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, ADC and fractional anisotropy (FA and colFA) volumes MAY be included
using the `TRACE`, `ADC`, `FA` and `colFA` suffixes, respectively.
If TRACE, ADC, FA, or colFA volume filenames match a diffusion series with all applicable entities,
such volumes SHOULD be computed from that series.
Scanner-generated trace-weighted, ADC, exponentiated ADC, and fractional anisotropy (FA and colFA) volumes
MAY be included using the `trace`, `ADC`, `expADC`, `FA` and `colFA` suffixes, respectively.
If trace, ADC, expADC, FA, or colFA volume filenames match a diffusion series with all applicable entities,
such volumes SHOULD have been 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.

Expand Down
35 changes: 22 additions & 13 deletions src/schema/objects/suffixes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,6 @@ DIC:
display_name: Differential interference contrast microscopy
description: |
Differential interference contrast microscopy imaging data
colFA:
value: colFA
display_name: Colored Fractional Anisotropy image
description: |
Diffusion images reflecting the directionality of the diffusion tensor color-coded in red for
left-right oriented fibers, in blue for superior-inferior oriented fibers and green for
anterior-posterior oriented fibers.
DF:
value: DF
display_name: Dark-field microscopy
Expand All @@ -58,7 +51,8 @@ FA:
value: FA
display_name: Fractional Anisotropy image
description: |
Diffusion images reflecting the directionality of the diffusion tensor
Scanner-generated derivative parametric map
reflecting the anisotropy of the diffusion tensor
FLAIR:
value: FLAIR
display_name: Fluid attenuated inversion recovery image
Expand Down Expand Up @@ -477,11 +471,6 @@ 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 Expand Up @@ -559,6 +548,15 @@ channels:
display_name: Channels File
description: |
Channel information.
colFA:
value: colFA
display_name: Colored Fractional Anisotropy image
description: |
Scanner-derived parametric map encoding both the anisotropy and principal direction of the diffusion tensor.
Image intensity is proportional to the Fractional Anisotropy (FA) measure;
image colour is determined by the principal eigenvector of the diffusion tensor,

Check failure on line 557 in src/schema/objects/suffixes.yaml

View workflow job for this annotation

GitHub Actions / codespell

colour ==> color
where red encodes the magnitude of the left-right component of that orientation,
with green and blue similarly encoding the anterior-posterior and inferior-superior components respectively.
coordsystem:
value: coordsystem
display_name: Coordinate System File
Expand Down Expand Up @@ -617,6 +615,12 @@ events:
display_name: Events
description: |
Event timing information from a behavioral task.
expADC:
value: expADC
display_name: Exponental ADC
description: |
Exponental ADC / Attenuation Coefficient / Attenuation Factor map,
as the ratio of trace-weighted to non-diffusion-weighted image intensity
fieldmap:
value: fieldmap
display_name: Fieldmap
Expand Down Expand Up @@ -831,6 +835,11 @@ stim:
display_name: Continuous recording
description: |
Continuous measures, such as parameters of a film or audio stimulus.
trace:
value: trace
display_name: Trace-weighted diffusion image
description: |
Trace-weighted image, as the mean intensity of diffusion-weighted images
uCT:
value: uCT
display_name: Micro-CT
Expand Down
5 changes: 3 additions & 2 deletions src/schema/rules/files/raw/dwi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,10 @@ sbref:
ScannerDerivatives:
suffixes:
- ADC
- colFA
- FA
- TRACE
- colFA
- expADC
- trace
extensions:
- .nii.gz
- .nii
Expand Down

0 comments on commit 04a96f5

Please sign in to comment.