Skip to content

Commit c3f51ad

Browse files
committed
DOC: Add docstring for anat_ribbon_wf
1 parent fb05822 commit c3f51ad

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

smriprep/workflows/surfaces.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,6 +1046,31 @@ def _sel(x):
10461046

10471047

10481048
def init_anat_ribbon_wf(name="anat_ribbon_wf"):
1049+
"""Create anatomical ribbon mask
1050+
1051+
Workflow Graph
1052+
1053+
.. workflow::
1054+
:graph2use: orig
1055+
:simple_form: yes
1056+
1057+
from smriprep.workflows.surfaces import init_anat_ribbon_wf
1058+
wf = init_anat_ribbon_wf()
1059+
1060+
Inputs
1061+
------
1062+
white
1063+
Left and right gray/white surfaces (as GIFTI files)
1064+
pial
1065+
Left and right pial surfaces (as GIFTI files)
1066+
ref_file
1067+
Reference image (one 3D volume) to define the target space
1068+
1069+
Outputs
1070+
-------
1071+
anat_ribbon
1072+
Cortical gray matter mask, sampled into ``ref_file`` space
1073+
"""
10491074
DEFAULT_MEMORY_MIN_GB = 0.01
10501075
workflow = pe.Workflow(name=name)
10511076

0 commit comments

Comments
 (0)