Skip to content

[ENH] Add DWI recommended metadata #2309

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

Open
kabilar wants to merge 6 commits into
base: master
Choose a base branch
from
+22 −0
Open

[ENH] Add DWI recommended metadata #2309

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5ef201d
Add recommended DWI metadata
kabilar Jan 16, 2026
69fc18f
Update metadata
kabilar Jan 16, 2026
e81113f
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 16, 2026
7af905f
Update field names and units based on feedback
kabilar Jan 26, 2026
eb380c5
Merge branch 'master' of https://github.com/bids-standard/bids-specif…
kabilar Jan 26, 2026
6851fa9
Fix example
kabilar Jan 27, 2026
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
2 changes: 2 additions & 0 deletions src/modality-specific-files/magnetic-resonance-imaging-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -922,6 +922,8 @@ JSON example:

```JSON
{
"BigDelta": 15.2,
"SmallDelta": 11.0,
"PhaseEncodingDirection": "j-",
"TotalReadoutTime": 0.095,
"B0FieldSource": ["phasediff_fmap0", "pepolar_fmap0"]
Expand Down
18 changes: 18 additions & 0 deletions src/schema/objects/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,15 @@ BasedOn:
items:
type: string
format: participant_relative
BigDelta:
name: BigDelta
display_name: Diffusion Gradient Separation
Copy link

@mharms mharms Jan 26, 2026

Choose a reason for hiding this comment

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

I'm not sure where/how these "display_name" fields show up, but I wonder if it should just be "Diffusion BigDelta"?

Copy link
Member Author

@kabilar kabilar Jan 27, 2026

Choose a reason for hiding this comment

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

One place it shows up is in the Glossary under the Name field. How about the following?

Suggested change
display_name: Diffusion Gradient Separation
display_name: Diffusion Big Delta (Δ)

description: |
In the context of a diffusion-weighted pulsed gradient spin echo sequence,
corresponds to the time between the leading edges of two successive
diffusion-encoding gradient pulses (Δ), specified in seconds.
type: number
unit: s
BloodDensity:
name: BloodDensity
display_name: Blood Density
Expand Down Expand Up @@ -3889,6 +3898,15 @@ SliceTiming:
type: number
minimum: 0
unit: s
SmallDelta:
name: SmallDelta
display_name: Diffusion Gradient Duration
description: |
In the context of a diffusion-weighted pulsed gradient spin echo sequence,
corresponds to the duration of a diffusion-encoding gradient pulse (δ),
specified in seconds.
type: number
unit: s
SoftwareFilters:
name: SoftwareFilters
display_name: Software Filters
Expand Down
2 changes: 2 additions & 0 deletions src/schema/rules/sidecars/dwi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,7 @@ MRIDiffusionOtherMetadata:
- suffix == "dwi"
- match(extension, "^\.nii(\.gz)?$")
fields:
BigDelta: recommended
SmallDelta: recommended
PhaseEncodingDirection: recommended
TotalReadoutTime: recommended