Skip to content

Commit 8d64329

Browse files
committed
add default settings in docstrings
1 parent 4514045 commit 8d64329

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

nipype/workflows/dmri/fsl/artifacts.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -509,12 +509,12 @@ def sdc_fmb(name='fmb_correction',
509509
bmap_params=dict(delta_te=2.46e-3),
510510
epi_params=dict(echospacing=0.77e-3,
511511
acc_factor=3,
512-
enc_dir='y-')):
512+
enc_dir='AP')):
513513
"""
514514
SDC stands for susceptibility distortion correction. FMB stands for
515515
fieldmap-based.
516516
517-
The fieldmap based method (FMB) implements SDC by using a mapping of the
517+
The fieldmap based (FMB) method implements SDC by using a mapping of the
518518
B0 field as proposed by [Jezzard95]_. This workflow uses the implementation
519519
of FSL (`FUGUE <http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FUGUE>`_). Phase
520520
unwrapping is performed using `PRELUDE
@@ -523,6 +523,16 @@ def sdc_fmb(name='fmb_correction',
523523
script in FSL `fsl_prepare_fieldmap
524524
<http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FUGUE/Guide#SIEMENS_data>`_.
525525
526+
Default settings
527+
----------------
528+
529+
>>> fugue_params=dict(smooth3d=2.0),
530+
>>> bmap_params=dict(delta_te=2.46e-3),
531+
>>> epi_params=dict(echospacing=0.77e-3,
532+
... acc_factor=3,
533+
... enc_dir='AP')
534+
535+
526536
Example
527537
-------
528538

0 commit comments

Comments
 (0)