Skip to content

Commit 09d4114

Browse files
committed
Add specific warnings for B0Field*, deduplicate sidecar tables
1 parent 18013e5 commit 09d4114

File tree

3 files changed

+22
-3
lines changed

3 files changed

+22
-3
lines changed

src/modality-specific-files/magnetic-resonance-imaging-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ A guide for using macros can be found at
161161
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
162162
-->
163163
{{ MACROS___make_sidecar_table([
164-
"mri.MRIB0FieldIdentifier",
164+
"fmap.MRIFieldmapB0FieldIdentifier",
165165
"mri.MRIEchoPlanarImagingAndB0FieldSource",
166166
])
167167
}}

src/schema/rules/sidecars/fmap.yaml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,16 @@ MRIFieldmapB0FieldIdentifier:
2323
- match(extension, '\.nii(\.gz)?$')
2424
- '!("IntendedFor" in sidecar)'
2525
fields:
26-
B0FieldIdentifier: recommended
26+
B0FieldIdentifier:
27+
level: recommended
28+
issue:
29+
code: B0_FIELD_IDENTIFIER_RECOMMENDED
30+
message: |
31+
File is missing B0FieldIdentifier metadata and IntendedFor metadata,
32+
so it will not be possible to use to perform susceptibility distortion correction.
33+
B0FieldIdentifier metadata permits the flexible selection of images
34+
for estimating B0 inhomogeneity fields, and B0FieldSource permits EPI
35+
images to indicate the identifier of the estimated field to use.
2736
2837
# Case 1: Phase-difference map and at least one magnitude image
2938
MRIFieldmapPhaseDifferencePhasediff:

src/schema/rules/sidecars/mri.yaml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,17 @@ MRIEchoPlanarImagingAndB0FieldSource:
385385
- intersects(dataset.datatypes, ['fmap'])
386386
- match(extension, "^\.nii(\.gz)?$")
387387
fields:
388-
B0FieldSource: recommended
388+
B0FieldSource:
389+
level: recommended
390+
issue:
391+
code: B0_FIELD_SOURCE_RECOMMENDED
392+
message: |
393+
File is missing B0FieldSource metadata, so it may not be possible to
394+
perform susceptibility distortion correction on it.
395+
B0FieldIdentifier metadata permits the flexible selection of images
396+
for estimating B0 inhomogeneity fields, and B0FieldSource permits EPI
397+
images to indicate the identifier of the estimated field to use.
398+
If associations are fully specified with `IntendedFor`, there is no need to change this.
389399
390400
MRIInstitutionInformation:
391401
selectors:

0 commit comments

Comments
 (0)