Skip to content

Commit 4a19e2d

Browse files
committed
added a docstring
1 parent 3d74360 commit 4a19e2d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

nipype/interfaces/fsl/dti.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,23 @@ class ProbTrackX2OutputSpec(ProbTrackXOutputSpec):
482482

483483

484484
class ProbTrackX2(ProbTrackX):
485+
""" Use FSL probtrackx2 for tractography on bedpostx results
486+
487+
Examples
488+
--------
489+
490+
>>> from nipype.interfaces import fsl
491+
>>> pbx2 = fsl.ProbTrackX2 seed='data.bedpostX/seed_source.nii.gz', \
492+
thsamples=['data.bedpostX/merged_th1samples.nii.gz'], \
493+
fsamples=['data.bedpostX/merged_f1samples.nii.gz'], \
494+
phsamples=['data.bedpostX/merged_ph1samples.nii.gz'], \
495+
mask='data.bedpostX/nodif_brain_mask.nii.gz', \
496+
out_dir='.',
497+
n_samples=3, \
498+
n_steps=10)
499+
>>> pbx2.cmdline
500+
'probtrackx2 --forcedir -m data.bedpostX/nodif_brain_mask.nii.gz --nsamples=3 --nsteps=10 --opd --dir=. --samples=merged --seed=data.bedpostX/seed_source.nii.gz'
501+
"""
485502
_cmd = 'probtrackx2'
486503
input_spec = ProbTrackX2InputSpec
487504
output_spec = ProbTrackX2OutputSpec

0 commit comments

Comments
 (0)