Skip to content

Commit 593aea8

Browse files
committed
update doctests
1 parent 0f0924a commit 593aea8

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

nipype/interfaces/mrtrix3/utils.py

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,7 @@ class MRResizeInputSpec(MRTrix3BaseInputSpec):
691691
(traits.Int, traits.Int, traits.Int),
692692
argstr='-size %d,%d,%d',
693693
mandatory=True,
694-
desc='Number of voxels in each dimension of output image'
694+
desc='Number of voxels in each dimension of output image',
695695
xor=['voxel_size', 'scale_factor'],
696696
)
697697
voxel_size = traits.Tuple(
@@ -744,20 +744,30 @@ class MRResize(MRTrix3Base):
744744
Example
745745
-------
746746
>>> import nipype.interfaces.mrtrix3 as mrt
747-
>>> resize = mrt.MRResize()
748-
>>> resize.inputs.in_file = 'dwi.mif'
749-
>>> resize.inputs.image_size = (256, 256, 144)
750-
>>> resize.cmdline # doctest: +ELLIPSIS
751-
'mrresize -interp cubic -size 256,256,144 dwi.mif dwi_resized.mif'
752-
>>> resize.run() # doctest: +SKIP
753-
>>> resize.inputs.voxel_size = (1, 1, 1)
754-
>>> resize.cmdline # doctest: +ELLIPSIS
747+
748+
Defining the new image resolution:
749+
>>> image_resize = mrt.MRResize()
750+
>>> image_resize.inputs.in_file = 'dwi.mif'
751+
>>> image_resize.inputs.image_size = (256, 256, 144)
752+
>>> image_resize.cmdline # doctest: +ELLIPSIS
753+
'mrresize -size 256,256,144 -interp cubic dwi.mif dwi_resized.mif'
754+
>>> image_resize.run() # doctest: +SKIP
755+
756+
Defining the new image's voxel size:
757+
>>> voxel_resize = mrt.MRResize()
758+
>>> voxel_resize.inputs.in_file = 'dwi.mif'
759+
>>> voxel_resize.inputs.voxel_size = (1, 1, 1)
760+
>>> voxel_resize.cmdline # doctest: +ELLIPSIS
755761
'mrresize -interp cubic -voxel 1,1,1 dwi.mif dwi_resized.mif'
756-
>>> resize.run() # doctest: +SKIP
757-
>>> resize.inputs.scale_factor = (2.0,2.0,2.0)
758-
>>> resize.cmdline # doctest: +ELLIPSIS
759-
'mrresize -interp cubic -scale 2.0,2.0,2.0 dwi.mif dwi_resized.mif'
760-
>>> resize.run() # doctest: +SKIP
762+
>>> voxel_resize.run() # doctest: +SKIP
763+
764+
Defining the scale factor of each image dimension:
765+
>>> scale_resize = mrt.MRResize()
766+
>>> scale_resize.inputs.in_file = 'dwi.mif'
767+
>>> scale_resize.inputs.scale_factor = (0.5,0.5,0.5)
768+
>>> scale_resize.cmdline # doctest: +ELLIPSIS
769+
'mrresize -interp cubic -scale 0.5,0.5,0.5 dwi.mif dwi_resized.mif'
770+
>>> scale_resize.run() # doctest: +SKIP
761771
"""
762772

763773
_cmd = 'mrresize'

0 commit comments

Comments
 (0)