Skip to content

Commit ef1f45d

Browse files
committed
ENH: Adds example input params for wrapped Ants DenoiseImage
1 parent ee81bc4 commit ef1f45d

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

nipype/interfaces/ants/segmentation.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -833,7 +833,22 @@ class DenoiseImage(ANTSCommand):
833833
"""
834834
Examples
835835
--------
836-
836+
>>> from nipype.interfaces.ants import DenoiseImage
837+
>>> denoise = DenoiseImage()
838+
>>> denoise.inputs.dimension = 3
839+
>>> denoise.inputs.input_image = 'input_scalar_image.nii.gz'
840+
>>> denoise.inputs.output_image = ['output_corrected_image.nii.gz']
841+
>>> print denoise.cmdline
842+
'DenoiseImage -d 3 -i input_scalar_image.nii.gz -n Gaussian -o output_corrected_image.nii.gz -s 1'
843+
844+
>>> denoise.inputs.noise_model = 'Rician'
845+
>>> denoise.inputs.shrink_factor = 2
846+
>>> print denoise.cmdline
847+
'DenoiseImage -d 3 -i input_scalar_image.nii.gz -n Rician -o output_corrected_image.nii.gz -s 2
848+
849+
>>> denoise.inputs.output_image = ['output_corrected_image.nii.gz', 'output_noise_image.nii.gz']
850+
>>> print denoise.cmdline
851+
'DenoiseImage -d 3 -i input_scalar_image.nii.gz -n Rician -o [output_corrected_image.nii.gz,output_noise_image.nii.gz] -s 2
837852
"""
838853
input_spec = DenoiseImageInputSpec
839854
output_spec = DenoiseImageOutputSpec

0 commit comments

Comments
 (0)