[ENH] Add ParallelReductionFactorOutOfPlane to MRI metadata (#1221)

* Add ParallelReductionFactorOutOfPlane to bids metadata. * Update src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md * ENH: Note that spatial encoding now includes out-of-plane * Update src/schema/objects/metadata.yaml Co-authored-by: Luke Edwards <[email protected]> * STY: Fix line length, grammar Co-authored-by: Luke Edwards <[email protected]> Co-authored-by: Chris Markiewicz <[email protected]> Co-authored-by: Chris Markiewicz <[email protected]>
bids-standard · Nov 4, 2022 · 6d71b6a · 6d71b6a
1 parent 57b9901
commit 6d71b6a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md b/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md
@@ -49,7 +49,7 @@ A guide for using macros can be found at
 -->
 {{ MACROS___make_sidecar_table("mri.MRISequenceSpecifics") }}
 
-### In-Plane Spatial Encoding
+### In- and Out-of-Plane Spatial Encoding
 
 <!-- This block generates a metadata table.
 These tables are defined in

diff --git a/src/schema/objects/metadata.yaml b/src/schema/objects/metadata.yaml
@@ -2183,11 +2183,23 @@ ParallelReductionFactorInPlane:
   name: ParallelReductionFactorInPlane
   display_name: Parallel Reduction Factor In Plane
   description: |
-    The parallel imaging (for instance, GRAPPA) factor.
+    The parallel imaging (for instance, GRAPPA) factor in plane.
     Use the denominator of the fraction of k-space encoded for each slice.
     For example, 2 means half of k-space is encoded.
     Corresponds to DICOM Tag 0018, 9069 `Parallel Reduction Factor In-plane`.
   type: number
+ParallelReductionFactorOutOfPlane:
+  name: ParallelReductionFactorOutOfPlane
+  display_name: Parallel Reduction Factor Out of Plane
+  description: |
+    The parallel imaging (for instance, GRAPPA) factor in the second phase encoding dimension of 3D sequences.
+    Use the denominator of the fraction of k-space encoded in the second phase encoding dimension.
+    For example, 2 means half of k-space is encoded.
+    Will typically be 1 for 2D sequences, as each slice in a 2D acquisition is usually fully encoded.
+    `ParallelReductionFactorOutOfPlane` should not be confused with `MultibandAccelerationFactor`,
+    as they imply different methods of accelerating the acquisition.
+    Corresponds to DICOM Tag 0018, 9155 `Parallel Reduction Factor out-of-plane`.
+  type: number
 PartialFourier:
   name: PartialFourier
   display_name: Partial Fourier

diff --git a/src/schema/rules/sidecars/mri.yaml b/src/schema/rules/sidecars/mri.yaml
@@ -117,6 +117,7 @@ MRISpatialEncoding:
   fields:
     NumberShots: recommended
     ParallelReductionFactorInPlane: recommended
+    ParallelReductionFactorOutOfPlane: recommended
     ParallelAcquisitionTechnique: recommended
     PartialFourier: recommended
     PartialFourierDirection: recommended