Skip to content

DOC: Include template metadata information when resampling BOLD to surface #3544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 3, 2025
Merged

DOC: Include template metadata information when resampling BOLD to surface #3544

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9cdd3a
doc: include metadata in workflow description
mgxd Oct 1, 2025
ffd69de
doc: simplify description
mgxd Oct 2, 2025
d88a28f
fix: Whitespace in resampling workflow description
effigies Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions fmriprep/workflows/bold/resampling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,9 +576,8 @@ def init_wb_vol_surf_wf(
workflow = Workflow(name=name)
workflow.__desc__ = """\
The BOLD time-series were resampled onto the native surface of the subject
using the "ribbon-constrained" method
using the "ribbon-constrained" method{' and then dilated by 10 mm' * dilate}.
"""
workflow.__desc__ += ' and then dilated by 10 mm.' if dilate else '.'

inputnode = pe.Node(
niu.IdentityInterface(
Expand Down Expand Up @@ -677,7 +676,7 @@ def init_wb_surf_surf_wf(

from fmriprep.workflows.bold.resampling import init_wb_surf_surf_wf
wf = init_wb_surf_surf_wf(
space='fsLR',
template='fsLR',
density='32k',
omp_nthreads=1,
mem_gb=1,
Expand Down Expand Up @@ -782,7 +781,7 @@ def init_wb_surf_surf_wf(
resample_to_template = pe.Node(
MetricResample(method='ADAP_BARY_AREA', area_surfs=True),
name='resample_to_template',
mem_gb=1,
mem_gb=mem_gb,
n_procs=omp_nthreads,
)

Expand All @@ -806,6 +805,18 @@ def init_wb_surf_surf_wf(
]),
]) # fmt:skip

# Fetch template metadata
template_meta = tf.get_metadata(template.split(':')[0])
template_refs = ['@{}'.format(template.split(':')[0].lower())]
if template_meta.get('RRID', None):
template_refs += [f'RRID:{template_meta["RRID"]}']

workflow.__desc__ = f"""\
The BOLD series was resampled to *{template_meta['Name']}*
[{', '.join(template_refs)}; TemplateFlow ID: {template}] using
the Connectome Workbench.
"""

return workflow


Expand Down