Skip to content

Commit 36a7f05

Browse files
committed
doctests: some fixed some added
1 parent a6acd1c commit 36a7f05

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

nipype/workflows/dmri/fsl/artifacts.py

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,18 @@ def all_fmb_pipeline(name='hmc_sdc_ecc',
3030
[Leemans09]_.
3131
3232
33+
Examples
34+
--------
35+
36+
>>> from nipype.workflows.dmri.fsl.artifacts import all_fmb_pipeline
37+
>>> allcorr = all_fmb_pipeline()
38+
>>> allcorr.inputs.inputnode.in_file = 'epi.nii'
39+
>>> allcorr.inputs.inputnode.in_bval = 'diffusion.bval'
40+
>>> allcorr.inputs.inputnode.in_bvec = 'diffusion.bvec'
41+
>>> allcorr.inputs.inputnode.bmap_mag = 'magnitude.nii'
42+
>>> allcorr.inputs.inputnode.bmap_pha = 'phase.nii'
43+
>>> allcorr.run() # doctest: +SKIP
44+
3345
"""
3446
inputnode = pe.Node(niu.IdentityInterface(fields=['in_file', 'in_bvec',
3547
'in_bval', 'bmap_pha', 'bmap_mag']), name='inputnode')
@@ -105,6 +117,17 @@ def all_peb_pipeline(name='hmc_sdc_ecc',
105117
[Leemans09]_.
106118
107119
120+
Examples
121+
--------
122+
123+
>>> from nipype.workflows.dmri.fsl.artifacts import all_peb_pipeline
124+
>>> allcorr = all_peb_pipeline()
125+
>>> allcorr.inputs.inputnode.in_file = 'epi.nii'
126+
>>> allcorr.inputs.inputnode.alt_file = 'epi_rev.nii'
127+
>>> allcorr.inputs.inputnode.in_bval = 'diffusion.bval'
128+
>>> allcorr.inputs.inputnode.in_bvec = 'diffusion.bvec'
129+
>>> allcorr.run() # doctest: +SKIP
130+
108131
"""
109132
inputnode = pe.Node(niu.IdentityInterface(fields=['in_file', 'in_bvec',
110133
'in_bval', 'alt_file']), name='inputnode')
@@ -285,7 +308,7 @@ def hmc_pipeline(name='motion_correct'):
285308
Example
286309
-------
287310
288-
>>> from nipype.workflows.dmri.preprocess.epi import hmc_pipeline
311+
>>> from nipype.workflows.dmri.fsl.artifacts import hmc_pipeline
289312
>>> hmc = hmc_pipeline()
290313
>>> hmc.inputs.inputnode.in_file = 'diffusion.nii'
291314
>>> hmc.inputs.inputnode.in_bvec = 'diffusion.bvec'
@@ -394,7 +417,7 @@ def ecc_pipeline(name='eddy_correct'):
394417
Example
395418
-------
396419
397-
>>> from nipype.workflows.dmri.preprocess.epi import ecc_pipeline
420+
>>> from nipype.workflows.dmri.fsl.artifacts import ecc_pipeline
398421
>>> ecc = ecc_pipeline()
399422
>>> ecc.inputs.inputnode.in_file = 'diffusion.nii'
400423
>>> ecc.inputs.inputnode.in_bval = 'diffusion.bval'
@@ -493,7 +516,7 @@ def sdc_fmb(name='fmb_correction',
493516
Example
494517
-------
495518
496-
>>> from nipype.workflows.dmri.preprocess.epi import sdc_fmb
519+
>>> from nipype.workflows.dmri.fsl.artifacts import sdc_fmb
497520
>>> fmb = sdc_fmb()
498521
>>> fmb.inputs.inputnode.in_file = 'diffusion.nii'
499522
>>> fmb.inputs.inputnode.in_bval = 'diffusion.bval'
@@ -641,9 +664,10 @@ def sdc_peb(name='peb_correction',
641664
Example
642665
-------
643666
644-
>>> from nipype.workflows.dmri.preprocess.epi import sdc_peb
667+
>>> from nipype.workflows.dmri.fsl.artifacts import sdc_peb
645668
>>> peb = sdc_peb()
646-
>>> peb.inputs.inputnode.in_file = 'diffusion.nii'
669+
>>> peb.inputs.inputnode.in_file = 'epi.nii'
670+
>>> peb.inputs.inputnode.alt_file = 'epi_rev.nii'
647671
>>> peb.inputs.inputnode.in_bval = 'diffusion.bval'
648672
>>> peb.inputs.inputnode.in_mask = 'mask.nii'
649673
>>> peb.run() # doctest: +SKIP

0 commit comments

Comments
 (0)