removing default values from topup (providing FSL default values in the description)

Author: djarecka

nipype/interfaces/fsl/epi.py

@@ -199,27 +199,24 @@ class TOPUPInputSpec(FSLCommandInputSpec):
     # TODO: the following traits admit values separated by commas, one value
     # per registration level inside topup.
     warp_res = traits.Float(
-        10.0, usedefault=True,
         argstr='--warpres=%f',
         desc=('(approximate) resolution (in mm) of warp '
               'basis for the different sub-sampling levels'
-              '.'))
-    subsamp = traits.Int(1, usedefault=True,
-                         argstr='--subsamp=%d', desc='sub-sampling scheme')
+              '(default in FSL 10).'))
+    subsamp = traits.Int(argstr='--subsamp=%d',
+                         desc='sub-sampling scheme (default in FSL 1)')
     fwhm = traits.Float(
-        8.0,
-        usedefault=True,
         argstr='--fwhm=%f',
-        desc='FWHM (in mm) of gaussian smoothing kernel')
+        desc='FWHM (in mm) of gaussian smoothing kernel (default in FSL 8)')
     config = traits.String(
         'b02b0.cnf',
         argstr='--config=%s',
         usedefault=True,
         desc=('Name of config file specifying command line '
               'arguments'))
     max_iter = traits.Int(
-        5, usedefault=True,
-        argstr='--miter=%d', desc='max # of non-linear iterations')
+        argstr='--miter=%d',
+        desc='max # of non-linear iterations (default in FSL 5)')
     reg_lambda = traits.Float(
         argstr='--lambda=%0.f',
         desc=('Weight of regularisation, default '
@@ -258,10 +255,9 @@ class TOPUPInputSpec(FSLCommandInputSpec):
         desc=('Minimisation method 0=Levenberg-Marquardt, '
               '1=Scaled Conjugate Gradient'))
     splineorder = traits.Int(
-        3, usedefault=True,
         argstr='--splineorder=%d',
         desc=('order of spline, 2->Qadratic spline, '
-              '3->Cubic spline'))
+              '3->Cubic spline (default in FSL 3)'))
     numprec = traits.Enum(
         'double',
         'float',
@@ -320,10 +316,9 @@ class TOPUP(FSLCommand):
     >>> topup.inputs.output_type = "NIFTI_GZ"
     >>> topup.cmdline # doctest: +ELLIPSIS
     'topup --config=b02b0.cnf --datain=topup_encoding.txt \
---fwhm=8.000000 --imain=b0_b0rev.nii --miter=5 \
---out=b0_b0rev_base --iout=b0_b0rev_corrected.nii.gz \
+--imain=b0_b0rev.nii --out=b0_b0rev_base --iout=b0_b0rev_corrected.nii.gz \
 --fout=b0_b0rev_field.nii.gz --jacout=jac --logout=b0_b0rev_topup.log \
---rbmout=xfm --dfout=warpfield --splineorder=3 --subsamp=1 --warpres=10.000000'
+--rbmout=xfm --dfout=warpfield'
     >>> res = topup.run() # doctest: +SKIP
 
     """

nipype/interfaces/fsl/tests/test_auto_TOPUP.py

@@ -26,19 +26,13 @@ def test_TOPUP_inputs():
             usedefault=True,
         ),
         estmov=dict(argstr='--estmov=%d', ),
-        fwhm=dict(
-            argstr='--fwhm=%f',
-            usedefault=True,
-        ),
+        fwhm=dict(argstr='--fwhm=%f', ),
         in_file=dict(
             argstr='--imain=%s',
             mandatory=True,
         ),
         interp=dict(argstr='--interp=%s', ),
-        max_iter=dict(
-            argstr='--miter=%d',
-            usedefault=True,
-        ),
+        max_iter=dict(argstr='--miter=%d', ),
         minmet=dict(argstr='--minmet=%d', ),
         numprec=dict(argstr='--numprec=%s', ),
         out_base=dict(
@@ -91,19 +85,10 @@ def test_TOPUP_inputs():
         regmod=dict(argstr='--regmod=%s', ),
         regrid=dict(argstr='--regrid=%d', ),
         scale=dict(argstr='--scale=%d', ),
-        splineorder=dict(
-            argstr='--splineorder=%d',
-            usedefault=True,
-        ),
+        splineorder=dict(argstr='--splineorder=%d', ),
         ssqlambda=dict(argstr='--ssqlambda=%d', ),
-        subsamp=dict(
-            argstr='--subsamp=%d',
-            usedefault=True,
-        ),
-        warp_res=dict(
-            argstr='--warpres=%f',
-            usedefault=True,
-        ),
+        subsamp=dict(argstr='--subsamp=%d', ),
+        warp_res=dict(argstr='--warpres=%f', ),
     )
     inputs = TOPUP.input_spec()