rf: Align resample_surfaces_wf arguments to templateflow.get

Author: effigies

src/smriprep/workflows/anatomical.py

@@ -382,7 +382,6 @@ def init_anat_preproc_wf(
             hcp_morphometrics_wf = init_hcp_morphometrics_wf(omp_nthreads=omp_nthreads)
             resample_surfaces_wf = init_resample_surfaces_wf(
                 surfaces=['white', 'pial', 'midthickness'],
-                space='fsLR',
                 density='32k' if cifti_output == '91k' else '59k',
             )
             morph_grayords_wf = init_morph_grayords_wf(

src/smriprep/workflows/surfaces.py

@@ -1322,13 +1322,16 @@ def init_anat_ribbon_wf(name='anat_ribbon_wf'):
 
 def init_resample_surfaces_wf(
     surfaces: list[str],
+    template: str = 'fsLR',
+    cohort: str | None = None,
+    space: str | None = 'fsLR',
     density: str | None = None,
     grayord_density: str | None = None,
-    space: str = 'fsLR',
     name: str = 'resample_surfaces_wf',
 ):
     """
-    Resample subject surfaces surface to specified space and density.
+    Resample subject surfaces surface to specified template space and density,
+    using a given registration space.
 
     Workflow Graph
         .. workflow::
@@ -1338,16 +1341,22 @@ def init_resample_surfaces_wf(
             from smriprep.workflows.surfaces import init_resample_surfaces_wf
             wf = init_resample_surfaces_wf(
                 surfaces=['white', 'pial', 'midthickness'],
-                space='onavg',
+                template='onavg',
                 density='10k',
             )
 
     Parameters
     ----------
     surfaces : :class:`list` of :class:`str`
         Names of surfaces (e.g., ``'white'``) to resample. Both hemispheres will be resampled.
-    space : :class:`str`
-        The space to resample to, e.g., ``'onavg'``, ``'fsLR'``.
+    template : :class:`str`
+        The template space to resample to, e.g., ``'onavg'``, ``'fsLR'``.
+    cohort : :class:`str` or :obj:`None`
+        The template cohort to use, if the template provides multiple.
+    space : :class:`str` or :obj:`None`
+        The registration space for which there are both subject and template
+        registration spheres.
+        If ``None``, the template space is used.
     density : :class:`str`
         The density to resample to, e.g., ``'10k'``, ``'41k'``. Number of vertices per hemisphere.
     name : :class:`str`
@@ -1357,12 +1366,12 @@ def init_resample_surfaces_wf(
     ------
     ``<surface>``
         Left and right GIFTIs for each surface name passed to ``surfaces``.
-    sphere_reg_fsLR
-        GIFTI surface mesh corresponding to the subject's fsLR registration sphere.
+    ``sphere_reg_<space>``
+        GIFTI surface mesh corresponding to the subject's registration sphere to ``space``.
 
     Outputs
     -------
-    ``<surface>``
+    ``<surface>_<template>``
         Left and right GIFTI surface mesh corresponding to the input surface, resampled to the
         specified space and density.
     """
@@ -1383,12 +1392,13 @@ def init_resample_surfaces_wf(
     workflow = Workflow(name=name)
 
     inputnode = pe.Node(
-        niu.IdentityInterface(fields=[*surfaces, 'sphere_reg_fsLR']),
+        niu.IdentityInterface(fields=[*surfaces, f'sphere_reg_{space}']),
         name='inputnode',
     )
 
     outputnode = pe.Node(
-        niu.IdentityInterface(fields=[f'{surf}_{space}' for surf in surfaces]), name='outputnode'
+        niu.IdentityInterface(fields=[f'{surf}_{template}' for surf in surfaces]),
+        name='outputnode',
     )
 
     surface_list = pe.Node(
@@ -1405,11 +1415,12 @@ def init_resample_surfaces_wf(
     resampler.inputs.new_sphere = [
         str(
             tf.get(
-                template=space,
+                template=template,
+                cohort=cohort,
+                space=space if space != template else None,
+                hemi=hemi,
                 density=density,
                 suffix='sphere',
-                hemi=hemi,
-                space=(None if space == 'fsLR' else 'fsLR'),
                 extension='.surf.gii',
             )
         )
@@ -1430,12 +1441,12 @@ def init_resample_surfaces_wf(
             for i, surf in enumerate(surfaces, start=1)
         ]),
         (inputnode, resampler, [
-            (('sphere_reg_fsLR', _repeat, len(surfaces)), 'current_sphere'),
+            ((f'sphere_reg_{space}', _repeat, len(surfaces)), 'current_sphere'),
         ]),
         (surface_list, resampler, [('out', 'surface_in')]),
         (resampler, surface_groups, [('surface_out', 'inlist')]),
         (surface_groups, outputnode, [
-            (f'out{i}', f'{surf}_{space}') for i, surf in enumerate(surfaces, start=1)
+            (f'out{i}', f'{surf}_{template}') for i, surf in enumerate(surfaces, start=1)
         ]),
     ])  # fmt:skip