[ENH] Add noRF suffix for MR excitation-free noise scans (bids-standa…

…rd#1451) * Add noRF suffix. * Update src/schema/objects/suffixes.yaml Co-authored-by: Dan Handwerker <[email protected]> * Update suffixes.yaml * Apply suggestions from code review Co-authored-by: Dan Handwerker <[email protected]> * Update src/schema/objects/suffixes.yaml Co-authored-by: Yaroslav Halchenko <[email protected]> * Update src/schema/objects/suffixes.yaml Co-authored-by: Yaroslav Halchenko <[email protected]> * Update src/schema/objects/suffixes.yaml Co-authored-by: Yaroslav Halchenko <[email protected]> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update src/schema/objects/suffixes.yaml * Add modality entity to noRF. --------- Co-authored-by: Dan Handwerker <[email protected]> Co-authored-by: Chris Markiewicz <[email protected]> Co-authored-by: Yaroslav Halchenko <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
markmikkelsen · Apr 24, 2024 · 5ed9030 · 5ed9030
1 parent 01025da
commit 5ed9030
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/src/schema/objects/suffixes.yaml b/src/schema/objects/suffixes.yaml
@@ -687,6 +687,25 @@ nirs:
   value: nirs
   display_name: Near Infrared Spectroscopy
   description: Data associated with a Shared Near Infrared Spectroscopy Format file.
+noRF:
+  value: noRF
+  display_name: No Radio Frequency Excitation Scan
+  description: |
+    An MR noise scan often acquired alongside another MR scan.
+
+    These noise scans are acquired by disabling the radio frequency excitation,
+    while maintaining all other parameters from the associated scan.
+    These can be acquired using some other sequence with RF excitation removed
+    or as part of sequences that turns off RF at the beginning or end of a run.
+    For example a `bold` scan where a few volumes are acquired with RF off.
+    There is no consistent DICOM denotation for these scans.
+
+    If multiple sequences with different suffixes but otherwise the same entities have `noRF`
+    sequences, they SHOULD be disambiguated using the modality entity
+    (for example, `mod-bold_noRF.nii.gz` and `mod-cbv_noRF.nii`).
+
+    `noRF` are typically used to estimate properties of the scanner and
+    sequence that are independent from the object being imaged.
 optodes:
   value: optodes
   display_name: Optodes

diff --git a/src/schema/rules/files/raw/func.yaml b/src/schema/rules/files/raw/func.yaml
@@ -23,6 +23,14 @@ func:
     part: optional
     chunk: optional
 
+norf:
+  $ref: rules.files.raw.func.func
+  suffixes:
+    - noRF
+  entities:
+    $ref: rules.files.raw.func.func.entities
+    modality: optional
+
 phase:
   suffixes:
     - phase # deprecated