@@ -54,10 +54,13 @@ class PrepareFieldmap(FSLCommand):
54
54
55
55
Examples
56
56
--------
57
+
58
+ >>> from nipype.interfaces.fsl import PrepareFieldmap
57
59
>>> prepare = PrepareFieldmap()
58
60
>>> prepare.inputs.in_phase = "phase.nii"
59
61
>>> prepare.inputs.in_magnitude = "magnitude.nii"
60
- >>> prepare.cmdline # doctest: +SKIP
62
+ >>> prepare.cmdline
63
+ 'fsl_prepare_fieldmap SIEMENS phase.nii magnitude.nii /home/oesteban/workspace/nipype/nipype/testing/data/phase_fslprepared.nii.gz 2.460000'
61
64
>>> res = prepare.run() # doctest: +SKIP
62
65
63
66
@@ -145,10 +148,13 @@ class TOPUP( FSLCommand ):
145
148
146
149
Examples
147
150
--------
151
+
152
+ >>> from nipype.interfaces.fsl import TOPUP
148
153
>>> topup = TOPUP()
149
154
>>> topup.inputs.in_file = "b0_b0rev.nii"
150
155
>>> topup.inputs.encoding_file = "topup_encoding.txt"
151
- >>> topup.cmdline # doctest: +SKIP
156
+ >>> topup.cmdline
157
+ 'topup --config=b02b0.cnf --datain=topup_encoding.txt --imain=b0_b0rev.nii --out=/home/oesteban/workspace/nipype/nipype/testing/data/nipypetu'
152
158
>>> res = topup.run() # doctest: +SKIP
153
159
154
160
"""
@@ -239,21 +245,22 @@ class ApplyTOPUPOutputSpec( TraitedSpec ):
239
245
out_corrected = File ( exists = True , desc = 'name of 4D image file with unwarped images' )
240
246
241
247
class ApplyTOPUP ( FSLCommand ):
242
- """ Interface for FSL topup, a tool for estimating and correcting susceptibility induced distortions
243
- Reference: http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/topup/ApplytopupUsersGuide
244
- Example: http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/topup/ExampleTopupFollowedByApplytopup
245
-
246
- topup --imain=<some 4D image> --datain=<text file> --config=<text file with parameters> --coutname=my_field
248
+ """ Interface for FSL topup, a tool for estimating and correcting susceptibility induced distortions.
249
+ `General reference <http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/topup/ApplytopupUsersGuide>`_
250
+ and `use example <http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/topup/ExampleTopupFollowedByApplytopup>`_.
247
251
248
252
249
253
Examples
250
254
--------
255
+
256
+ >>> from nipype.interfaces.fsl import ApplyTOPUP
251
257
>>> applytopup = ApplyTOPUP()
252
258
>>> applytopup.inputs.in_files = [ "epi.nii", "epi_rev.nii" ]
253
259
>>> applytopup.inputs.encoding_file = "topup_encoding.txt"
254
260
>>> applytopup.inputs.in_index = [ 1,2 ]
255
261
>>> applytopup.inputs.in_topup = "my_topup_results"
256
- >>> applytopup.cmdline # doctest: +SKIP
262
+ >>> applytopup.cmdline
263
+ 'applytopup --datain=topup_encoding.txt --imain=epi.nii,epi_rev.nii --inindex=1,2 --topup=my_topup_results --out=/home/oesteban/workspace/nipype/nipype/testing/data/nipypeatu'
257
264
>>> res = applytopup.run() # doctest: +SKIP
258
265
259
266
"""
@@ -315,20 +322,23 @@ class EddyOutputSpec( TraitedSpec ):
315
322
out_parameter = File ( exists = True , desc = 'text file with parameters definining the field and movement for each scan' )
316
323
317
324
class Eddy ( FSLCommand ):
318
- """ Interface for FSL eddy, a tool for estimating and correcting eddy currents induced distortions
319
- User guide: http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/Eddy/UsersGuide
320
- Regarding acqp file: http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/eddy/Faq#How_do_I_know_what_to_put_into_my_--acqp_file
325
+ """ Interface for FSL eddy, a tool for estimating and correcting eddy currents induced distortions.
326
+ ` User guide < http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/Eddy/UsersGuide>`_ and
327
+ `more info regarding acqp file < http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/eddy/Faq#How_do_I_know_what_to_put_into_my_--acqp_file>`_.
321
328
322
329
Examples
323
330
--------
331
+
332
+ >>> from nipype.interfaces.fsl import Eddy
324
333
>>> eddy = Eddy()
325
334
>>> eddy.inputs.in_file = 'epi.nii'
326
335
>>> eddy.inputs.in_mask = 'epi_mask.nii'
327
336
>>> eddy.inputs.in_index = 'epi_index.txt'
328
337
>>> eddy.inputs.in_acqp = 'epi_acqp.txt'
329
338
>>> eddy.inputs.in_bvec = 'bvecs.scheme'
330
339
>>> eddy.inputs.in_bval = 'bvals.scheme'
331
- >>> eddy.cmdline # doctest: +SKIP
340
+ >>> eddy.cmdline
341
+ 'eddy --acqp=epi_acqp.txt --bvals=bvals.scheme --bvecs=bvecs.scheme --imain=epi.nii --index=epi_index.txt --mask=epi_mask.nii --out=/home/oesteban/workspace/nipype/nipype/testing/data/eddy_corrected'
332
342
>>> res = eddy.run() # doctest: +SKIP
333
343
334
344
@@ -401,11 +411,14 @@ class EPIDeWarp(FSLCommand):
401
411
402
412
Examples
403
413
--------
414
+
415
+ >>> from nipype.interfaces.fsl import EPIDeWarp
404
416
>>> dewarp = EPIDeWarp()
405
417
>>> dewarp.inputs.epi_file = "functional.nii"
406
418
>>> dewarp.inputs.mag_file = "magnitude.nii"
407
419
>>> dewarp.inputs.dph_file = "phase.nii"
408
- >>> dewarp.cmdline # doctest: +SKIP
420
+ >>> dewarp.cmdline
421
+ 'epidewarp.fsl --mag magnitude.nii --dph phase.nii --epi functional.nii --esp 0.58 --exfdw /home/oesteban/workspace/nipype/nipype/testing/data/exfdw.nii.gz --nocleanup --sigma 2 --tediff 2.46 --tmpdir /home/oesteban/workspace/nipype/nipype/testing/data/temp --vsm /home/oesteban/workspace/nipype/nipype/testing/data/vsm.nii.gz'
409
422
>>> res = dewarp.run() # doctest: +SKIP
410
423
411
424
References
@@ -486,10 +499,13 @@ class SigLoss(FSLCommand):
486
499
487
500
Examples
488
501
--------
502
+
503
+ >>> from nipype.interfaces.fsl import SigLoss
489
504
>>> sigloss = SigLoss()
490
505
>>> sigloss.inputs.in_file = "phase.nii"
491
506
>>> sigloss.inputs.echo_time = 0.03
492
- >>> sigloss.cmdline # doctest: +SKIP
507
+ >>> sigloss.cmdline
508
+ 'sigloss --te=0.030000 -i phase.nii -s /home/oesteban/workspace/nipype/nipype/testing/data/phase_sigloss.nii.gz'
493
509
>>> res = sigloss.run() # doctest: +SKIP
494
510
"""
495
511
input_spec = SigLossInputSpec
@@ -525,9 +541,10 @@ class EddyCorrect(FSLCommand):
525
541
Example
526
542
-------
527
543
528
- >>> from nipype.interfaces import fsl
529
- >>> eddyc = fsl.EddyCorrect(in_file='diffusion.nii', out_file="diffusion_edc.nii", ref_num=0)
530
- >>> eddyc.cmdline # doctest: +SKIP
544
+ >>> from nipype.interfaces.fsl import EddyCorrect
545
+ >>> eddyc = EddyCorrect(in_file='diffusion.nii', out_file="diffusion_edc.nii", ref_num=0)
546
+ >>> eddyc.cmdline
547
+ 'eddy_correct diffusion.nii diffusion_edc.nii 0'
531
548
532
549
"""
533
550
_cmd = 'eddy_correct'
0 commit comments