Skip to content

Commit bf60b75

Browse files
josephmjeeffigies
authored andcommitted
update variable names
1 parent 46608c5 commit bf60b75

File tree

2 files changed

+35
-30
lines changed

2 files changed

+35
-30
lines changed

nipype/interfaces/fsl/epi.py

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -675,8 +675,6 @@ class EddyInputSpec(FSLCommandInputSpec):
675675
desc="Do NOT perform a post-eddy alignment of " "shells",
676676
)
677677
fwhm = traits.Float(
678-
default_value=0.0,
679-
usedefault=True,
680678
desc=("FWHM for conditioning filter when estimating " "the parameters"),
681679
argstr="--fwhm=%s",
682680
)
@@ -740,7 +738,7 @@ class EddyInputSpec(FSLCommandInputSpec):
740738
desc=(
741739
"Multi-band offset (-1 if bottom slice removed, 1 if " "top slice removed"
742740
),
743-
requires=["mb"],
741+
requires=["multiband_factor"],
744742
min_ver="5.0.10",
745743
)
746744

@@ -750,27 +748,27 @@ class EddyInputSpec(FSLCommandInputSpec):
750748
requires=["use_cuda"],
751749
min_ver="5.0.11",
752750
)
753-
slice2vol_iterations = traits.Int(
754-
argstr="--s2v_niter=%s",
751+
slice2vol_niter = traits.Int(
752+
argstr="--s2v_niter=%d",
755753
desc="Number of iterations for slice-to-vol",
756754
requires=["mporder"],
757755
min_ver="5.0.11",
758756
)
759-
s2v_lambda = traits.Int(
760-
agstr="--s2v_lambda",
757+
slice2vol_lambda = traits.Int(
758+
argstr="--s2v_lambda=%d",
761759
desc="Regularisation weight for slice-to-vol movement (reasonable range 1-10)",
762760
requires=["mporder"],
763761
min_ver="5.0.11",
764762
)
765-
s2v_interp = traits.Enum(
763+
slice2vol_interp = traits.Enum(
766764
"trilinear",
767765
"spline",
768766
argstr="--s2v_interp=%s",
769767
desc="Slice-to-vol interpolation model for estimation step",
770768
requires=["mporder"],
771769
min_ver="5.0.11",
772770
)
773-
slspec = traits.File(
771+
slice_order = traits.File(
774772
exists=True,
775773
argstr="--slspec=%s",
776774
desc="Name of text file completely specifying slice/group acquisition",
@@ -783,7 +781,7 @@ class EddyInputSpec(FSLCommandInputSpec):
783781
argstr="--json=%s",
784782
desc="Name of .json text file with information about slice timing",
785783
requires=["mporder"],
786-
xor=["slspec"],
784+
xor=["slice_order"],
787785
min_ver="6.0.1",
788786
)
789787

@@ -961,7 +959,7 @@ class Eddy(FSLCommand):
961959
Running eddy on an Nvidia GPU using cuda:
962960
>>> eddy.inputs.use_cuda = True
963961
>>> eddy.cmdline # doctest: +ELLIPSIS
964-
'eddy_cuda --flm=quadratic --ff=10.0 --fwhm=0.0 \
962+
'eddy_cuda --flm=quadratic --ff=10.0 \
965963
--acqp=epi_acqp.txt --bvals=bvals.scheme --bvecs=bvecs.scheme \
966964
--imain=epi.nii --index=epi_index.txt --mask=epi_mask.nii \
967965
--interp=spline --resamp=jac --niter=5 --nvoxhp=1000 \
@@ -970,7 +968,7 @@ class Eddy(FSLCommand):
970968
Running eddy on a CPU using OpenMP:
971969
>>> eddy.inputs.use_cuda = False
972970
>>> eddy.cmdline # doctest: +ELLIPSIS
973-
'eddy_openmp --flm=quadratic --ff=10.0 --fwhm=0.0 \
971+
'eddy_openmp --flm=quadratic --ff=10.0 \
974972
--acqp=epi_acqp.txt --bvals=bvals.scheme --bvecs=bvecs.scheme \
975973
--imain=epi.nii --index=epi_index.txt --mask=epi_mask.nii \
976974
--interp=spline --resamp=jac --niter=5 --nvoxhp=1000 \
@@ -979,17 +977,17 @@ class Eddy(FSLCommand):
979977
Running eddy with slice-to-volume motion correction:
980978
>>> eddy.inputs.use_cuda = True
981979
>>> eddy.inputs.mporder = 6
982-
>>> eddy.inputs.s2v_niter = 5
983-
>>> eddy.inputs.s2v_lambda = 1
984-
>>> eddy.inputs.s2v_interp = 'trilinear'
985-
>>> eddy.inputs.slspec = 'epi_slspec.txt'
980+
>>> eddy.inputs.slice2vol_niter = 5
981+
>>> eddy.inputs.slice2vol_lambda = 1
982+
>>> eddy.inputs.slice2vol_interp = 'trilinear'
983+
>>> eddy.inputs.slice_order = 'epi_slspec.txt'
986984
>>> eddy.cmdline # doctest: +ELLIPSIS
987-
'eddy_cuda --flm=quadratic --ff=10.0 --fwhm=0.0 \
985+
'eddy_cuda --flm=quadratic --ff=10.0 \
988986
--acqp=epi_acqp.txt --bvals=bvals.scheme --bvecs=bvecs.scheme \
989987
--imain=epi.nii --index=epi_index.txt --mask=epi_mask.nii \
990988
--interp=spline --resamp=jac --mporder=6 --niter=5 --nvoxhp=1000 \
991-
--out=.../eddy_corrected --s2v_interp=trilinear --s2v_niter=5 \
992-
--slm=none --slspec=epi_slspec.txt'
989+
--out=.../eddy_corrected --s2v_interp=trilinear --s2v_lambda=1 \
990+
--s2v_niter=5 --slspec=epi_slspec.txt --slm=none'
993991
>>> res = eddy.run() # doctest: +SKIP
994992
995993
"""

nipype/interfaces/fsl/tests/test_auto_Eddy.py

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def test_Eddy_inputs():
1717
field_mat=dict(argstr="--field_mat=%s", extensions=None,),
1818
flm=dict(argstr="--flm=%s", usedefault=True,),
1919
fudge_factor=dict(argstr="--ff=%s", usedefault=True,),
20-
fwhm=dict(argstr="--fwhm=%s", usedefault=True,),
20+
fwhm=dict(argstr="--fwhm=%s",),
2121
in_acqp=dict(argstr="--acqp=%s", extensions=None, mandatory=True,),
2222
in_bval=dict(argstr="--bvals=%s", extensions=None, mandatory=True,),
2323
in_bvec=dict(argstr="--bvecs=%s", extensions=None, mandatory=True,),
@@ -32,10 +32,11 @@ def test_Eddy_inputs():
3232
interp=dict(argstr="--interp=%s", usedefault=True,),
3333
is_shelled=dict(argstr="--data_is_shelled",),
3434
json=dict(
35-
argstr="--json=%s", min_ver="6.0.1", requires=["mporder"], xor=["slspec"],
35+
argstr="--json=%s",
36+
min_ver="6.0.1",
37+
requires=["mporder"],
38+
xor=["slice_order"],
3639
),
37-
mb=dict(argstr="--mb=%s", min_ver="5.0.10",),
38-
mb_offs=dict(argstr="--mb_offs=%s", min_ver="5.0.10", requires=["mb"],),
3940
mbs_ksp=dict(
4041
argstr="--mbs_ksp=%smm",
4142
min_ver="6.0.1",
@@ -53,6 +54,10 @@ def test_Eddy_inputs():
5354
),
5455
method=dict(argstr="--resamp=%s", usedefault=True,),
5556
mporder=dict(argstr="--mporder=%s", min_ver="5.0.11", requires=["use_cuda"],),
57+
multiband_factor=dict(argstr="--mb=%s", min_ver="5.0.10",),
58+
multiband_offset=dict(
59+
argstr="--mb_offs=%d", min_ver="5.0.10", requires=["multiband_factor"],
60+
),
5661
niter=dict(argstr="--niter=%s", usedefault=True,),
5762
num_threads=dict(nohash=True, usedefault=True,),
5863
nvoxhp=dict(argstr="--nvoxhp=%s", usedefault=True,),
@@ -65,18 +70,20 @@ def test_Eddy_inputs():
6570
output_type=dict(),
6671
repol=dict(argstr="--repol",),
6772
residuals=dict(argstr="--residuals", min_ver="5.0.10",),
68-
s2v_interp=dict(
73+
session=dict(argstr="--session=%s", extensions=None,),
74+
slice2vol_interp=dict(
6975
argstr="--s2v_interp=%s", min_ver="5.0.11", requires=["mporder"],
7076
),
71-
s2v_lambda=dict(agstr="--s2v_lambda", min_ver="5.0.11", requires=["mporder"],),
72-
s2v_niter=dict(
73-
argstr="--s2v_niter=%s", min_ver="5.0.11", requires=["mporder"],
77+
slice2vol_lambda=dict(
78+
argstr="--s2v_lambda=%d", min_ver="5.0.11", requires=["mporder"],
7479
),
75-
session=dict(argstr="--session=%s", extensions=None,),
76-
slm=dict(argstr="--slm=%s", usedefault=True,),
77-
slspec=dict(
80+
slice2vol_niter=dict(
81+
argstr="--s2v_niter=%d", min_ver="5.0.11", requires=["mporder"],
82+
),
83+
slice_order=dict(
7884
argstr="--slspec=%s", min_ver="5.0.11", requires=["mporder"], xor=["json"],
7985
),
86+
slm=dict(argstr="--slm=%s", usedefault=True,),
8087
use_cuda=dict(),
8188
)
8289
inputs = Eddy.input_spec()

0 commit comments

Comments
 (0)