Skip to content

Commit

Permalink
DOC: Add docstring for anat_ribbon_wf
Browse files Browse the repository at this point in the history
  • Loading branch information
effigies committed Aug 29, 2023
1 parent fb05822 commit c3f51ad
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions smriprep/workflows/surfaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -1046,6 +1046,31 @@ def _sel(x):


def init_anat_ribbon_wf(name="anat_ribbon_wf"):
"""Create anatomical ribbon mask
Workflow Graph
.. workflow::
:graph2use: orig
:simple_form: yes
from smriprep.workflows.surfaces import init_anat_ribbon_wf
wf = init_anat_ribbon_wf()
Inputs
------
white
Left and right gray/white surfaces (as GIFTI files)
pial
Left and right pial surfaces (as GIFTI files)
ref_file
Reference image (one 3D volume) to define the target space
Outputs
-------
anat_ribbon
Cortical gray matter mask, sampled into ``ref_file`` space
"""
DEFAULT_MEMORY_MIN_GB = 0.01
workflow = pe.Workflow(name=name)

Expand Down

0 comments on commit c3f51ad

Please sign in to comment.