Test field map collection

qsiprep/tests/test_utils_grouping.py

@@ -66,6 +66,74 @@
     ],
 }
 
+dset_fmap_intendedfor_relpath = {
+    '01': [
+        {
+            'fmap': [
+                {
+                    'dir': 'PA',
+                    'suffix': 'epi',
+                    'metadata': {
+                        'IntendedFor': ['dwi/sub-01_dir-AP_dwi.nii.gz'],
+                    },
+                },
+            ],
+            'dwi': [
+                {
+                    'dir': 'AP',
+                    'suffix': 'dwi',
+                },
+            ],
+        },
+    ],
+}
+dset_fmap_intendedfor_bidsuri = {
+    '01': [
+        {
+            'fmap': [
+                {
+                    'dir': 'PA',
+                    'suffix': 'epi',
+                    'metadata': {
+                        'IntendedFor': ['bids::sub-01/dwi/sub-01_dir-AP_dwi.nii.gz'],
+                    },
+                },
+            ],
+            'dwi': [
+                {
+                    'dir': 'AP',
+                    'suffix': 'dwi',
+                },
+            ],
+        },
+    ],
+}
+dset_fmap_b0fields = {
+    '01': [
+        {
+            'fmap': [
+                {
+                    'dir': 'PA',
+                    'suffix': 'epi',
+                    'metadata': {
+                        'B0FieldIdentifier': 'pepolar',
+                    },
+                },
+            ],
+            'dwi': [
+                {
+                    'dir': 'AP',
+                    'suffix': 'dwi',
+                    'metadata': {
+                        'B0FieldIdentifier': 'pepolar',
+                        'B0FieldSource': 'pepolar',
+                    },
+                },
+            ],
+        },
+    ],
+}
+
 
 def test_get_entity_groups_with_multipartid(tmpdir):
     """Test the get_entity_groups function."""
@@ -117,6 +185,44 @@ def test_get_entity_groups_without_multipartid(tmpdir):
     check_expected(entity_groups, expected)
 
 
+def test_get_fieldmaps(tmp_path_factory):
+    """Test the get_fieldmaps function."""
+    base_dir = tmp_path_factory.mktemp('test_get_fieldmaps')
+
+    # Check that relative paths are correctly handled
+    bids_dir = base_dir / 'dset_fmap_intendedfor_relpath'
+    generate_bids_skeleton(str(bids_dir), dset_fmap_intendedfor_relpath)
+    layout = BIDSLayout(str(bids_dir))
+    dwi_file = layout.get(suffix='dwi', extension='nii.gz', return_type='filename')[0]
+    fieldmaps = layout.get_fieldmap(dwi_file, return_list=True)
+    assert len(fieldmaps) == 1
+    assert fieldmaps[0]['suffix'] == 'epi'
+    assert layout.get_file(fieldmaps[0]['epi']).get_metadata()['IntendedFor'] == [
+        'dwi/sub-01_dir-AP_dwi.nii.gz'
+    ]
+
+    # Check that BIDS URI paths are correctly handled
+    bids_dir = base_dir / 'dset_fmap_intendedfor_bidsuri'
+    generate_bids_skeleton(str(bids_dir), dset_fmap_intendedfor_bidsuri)
+    layout = BIDSLayout(str(bids_dir))
+    dwi_file = layout.get(suffix='dwi', extension='nii.gz', return_type='filename')[0]
+    fieldmaps = layout.get_fieldmap(dwi_file, return_list=True)
+    assert len(fieldmaps) == 1
+    assert fieldmaps[0]['suffix'] == 'epi'
+    assert layout.get_file(fieldmaps[0]['epi']).get_metadata()['IntendedFor'] == [
+        'bids::sub-01/dwi/sub-01_dir-AP_dwi.nii.gz'
+    ]
+
+    # Check that B0FieldIdentifier and B0FieldSource are correctly handled
+    bids_dir = base_dir / 'dset_fmap_b0fields'
+    generate_bids_skeleton(str(bids_dir), dset_fmap_b0fields)
+    layout = BIDSLayout(str(bids_dir))
+    dwi_file = layout.get(suffix='dwi', extension='nii.gz', return_type='filename')[0]
+    fieldmaps = layout.get_fieldmap(dwi_file, return_list=True)
+    assert len(fieldmaps) == 1
+    assert fieldmaps[0]['suffix'] == 'epi'
+
+
 def check_expected(subject_data, expected):
     """Check expected values."""
     if isinstance(expected, str):