Skip to content

Commit 71e57b8

Browse files
committed
DOC: Update init_bold_wf docstring
1 parent 5cdceda commit 71e57b8

File tree

1 file changed

+47
-5
lines changed

1 file changed

+47
-5
lines changed

fmriprep/workflows/bold/base.py

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,26 @@ def init_bold_wf(
110110
t1w_dseg
111111
Segmentation of preprocessed structural image, including
112112
gray-matter (GM), white-matter (WM) and cerebrospinal fluid (CSF)
113-
anat2std_xfm
114-
List of transform files, collated with templates
113+
t1w_tpms
114+
List of tissue probability maps in T1w space
115115
subjects_dir
116116
FreeSurfer SUBJECTS_DIR
117117
subject_id
118118
FreeSurfer subject ID
119119
fsnative2t1w_xfm
120120
LTA-style affine matrix translating from FreeSurfer-conformed subject space to T1w
121+
white
122+
FreeSurfer white matter surfaces, in T1w space, collated left, then right
123+
midthickness
124+
FreeSurfer mid-thickness surfaces, in T1w space, collated left, then right
125+
pial
126+
FreeSurfer pial surfaces, in T1w space, collated left, then right
127+
sphere_reg_fsLR
128+
Registration spheres from fsnative to fsLR space, collated left, then right
129+
thickness
130+
FreeSurfer thickness metrics, collated left, then right
131+
anat_ribbon
132+
Binary cortical ribbon mask in T1w space
121133
fmap_id
122134
Unique identifiers to select fieldmap files
123135
fmap
@@ -130,14 +142,44 @@ def init_bold_wf(
130142
List of fieldmap masks (collated with fmap_id)
131143
sdc_method
132144
List of fieldmap correction method names (collated with fmap_id)
145+
anat2std_xfm
146+
Transform from anatomical space to standard space
147+
std_t1w
148+
T1w reference image in standard space
149+
std_mask
150+
Brain (binary) mask of the standard reference image
151+
std_space
152+
Value of space entity to be used in standard space output filenames
153+
std_resolution
154+
Value of resolution entity to be used in standard space output filenames
155+
std_cohort
156+
Value of cohort entity to be used in standard space output filenames
157+
anat2mni6_xfm
158+
Transform from anatomical space to MNI152NLin6Asym space
159+
mni6_mask
160+
Brain (binary) mask of the MNI152NLin6Asym reference image
161+
mni2009c2anat_xfm
162+
Transform from MNI152NLin2009cAsym to anatomical space
163+
164+
Note that ``anat2std_xfm``, ``std_space``, ``std_resolution``,
165+
``std_cohort``, ``std_t1w`` and ``std_mask`` are treated as single
166+
inputs. In order to resample to multiple target spaces, connect
167+
these fields to an iterable.
133168
134169
See Also
135170
--------
136171
137172
* :func:`~fmriprep.workflows.bold.fit.init_bold_fit_wf`
138173
* :func:`~fmriprep.workflows.bold.fit.init_bold_native_wf`
174+
* :func:`~fmriprep.workflows.bold.apply.init_bold_volumetric_resample_wf`
139175
* :func:`~fmriprep.workflows.bold.outputs.init_ds_bold_native_wf`
176+
* :func:`~fmriprep.workflows.bold.outputs.init_ds_volumes_wf`
140177
* :func:`~fmriprep.workflows.bold.t2s.init_t2s_reporting_wf`
178+
* :func:`~fmriprep.workflows.bold.resampling.init_bold_surf_wf`
179+
* :func:`~fmriprep.workflows.bold.resampling.init_bold_fsLR_resampling_wf`
180+
* :func:`~fmriprep.workflows.bold.resampling.init_bold_grayords_wf`
181+
* :func:`~fmriprep.workflows.bold.confounds.init_bold_confs_wf`
182+
* :func:`~fmriprep.workflows.bold.confounds.init_carpetplot_wf`
141183
142184
"""
143185
from niworkflows.engine.workflows import LiterateWorkflow as Workflow
@@ -205,8 +247,8 @@ def init_bold_wf(
205247
"white",
206248
"midthickness",
207249
"pial",
208-
"thickness",
209250
"sphere_reg_fsLR",
251+
"thickness",
210252
"anat_ribbon",
211253
# Fieldmap registration
212254
"fmap",
@@ -217,11 +259,11 @@ def init_bold_wf(
217259
"sdc_method",
218260
# Volumetric templates
219261
"anat2std_xfm",
262+
"std_t1w",
263+
"std_mask",
220264
"std_space",
221265
"std_resolution",
222266
"std_cohort",
223-
"std_t1w",
224-
"std_mask",
225267
# MNI152NLin6Asym warp, for CIFTI use
226268
"anat2mni6_xfm",
227269
"mni6_mask",

0 commit comments

Comments
 (0)