Skip to content

Commit f897e2e

Browse files
committed
DOC: Update docstring, workflow description
1 parent 409421c commit f897e2e

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

fmriprep/workflows/bold/registration.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,8 @@ def init_bbreg_wf(
210210
Build a workflow to run FreeSurfer's ``bbregister``.
211211
212212
This workflow uses FreeSurfer's ``bbregister`` to register a BOLD image to
213-
a T2-weighted structural image (if available), and ultimately a T1-weighted structual image.
213+
a T1-weighted structual image, leveraging a T2-weighted image (if available)
214+
in the intermediate for improved tissue contrast.
214215
215216
It is a counterpart to :py:func:`~fmriprep.workflows.bold.registration.init_fsl_bbr_wf`,
216217
which performs the same task using FSL's FLIRT with a BBR cost function.
@@ -244,6 +245,8 @@ def init_bbreg_wf(
244245
bold2t1w_init : str, 'header' or 'register'
245246
If ``'header'``, use header information for initialization of BOLD and T1 images.
246247
If ``'register'``, align volumes by their centers.
248+
use_t2w : :obj:`bool`, optional
249+
If a T2w reference image is available, use it as an intermediate for BBR.
247250
name : :obj:`str`, optional
248251
Workflow name (default: bbreg_wf)
249252
@@ -263,6 +266,8 @@ def init_bbreg_wf(
263266
Unused (see :py:func:`~fmriprep.workflows.bold.registration.init_fsl_bbr_wf`)
264267
t1w_dseg
265268
Unused (see :py:func:`~fmriprep.workflows.bold.registration.init_fsl_bbr_wf`)
269+
t2w_preproc
270+
T2w reference in T1w space (Only used if ``use_t2w`` is ``True``)
266271
267272
Outputs
268273
-------
@@ -292,6 +297,11 @@ def init_bbreg_wf(
292297
else 'to account for distortions remaining in the BOLD reference',
293298
)
294299

300+
if use_t2w:
301+
workflow.__desc__ += (
302+
" A T2w reference was used as an intermediate volume to improve tissue contrast." ""
303+
)
304+
295305
inputnode = pe.Node(
296306
niu.IdentityInterface(
297307
[
@@ -469,6 +479,8 @@ def init_fsl_bbr_wf(
469479
bold2t1w_init : str, 'header' or 'register'
470480
If ``'header'``, use header information for initialization of BOLD and T1 images.
471481
If ``'register'``, align volumes by their centers.
482+
use_t2w : :obj:`bool`, optional
483+
Unused
472484
name : :obj:`str`, optional
473485
Workflow name (default: fsl_bbr_wf)
474486

0 commit comments

Comments
 (0)