Skip to content

Commit dd6ab0b

Browse files
committed
doc: update docs to guide user about dcm2niix based file list conversion
1 parent b876f4f commit dd6ab0b

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

nipype/interfaces/dcm2nii.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,12 +264,17 @@ class Dcm2niixInputSpec(CommandLineInputSpec):
264264
position=-1,
265265
copyfile=False,
266266
mandatory=True,
267+
desc=('A set of filenames to be converted. Note that the current '
268+
'version of dcm2niix converts any files in the directory. To '
269+
'only convert specific files they should be in an isolated '
270+
'directory'),
267271
xor=['source_dir'])
268272
source_dir = Directory(
269273
exists=True,
270274
argstr="%s",
271275
position=-1,
272276
mandatory=True,
277+
desc='A directory containing dicom files to be converted',
273278
xor=['source_names'])
274279
out_filename = traits.Str(
275280
argstr="-f %s",
@@ -377,6 +382,10 @@ class Dcm2niix(CommandLine):
377382
'dcm2niix -b y -z y -5 -x n -t n -m n -o ds005 -s n -v n dicomdir'
378383
>>> converter.run() # doctest: +SKIP
379384
385+
# In the example below, we note that the current version of dcm2niix
386+
# converts any files in the directory containing the files in the list. We
387+
# also do not support nested filenames with this option. Thus all files
388+
# should have a common root directory.
380389
>>> converter = Dcm2niix()
381390
>>> converter.inputs.source_names = ['functional_1.dcm', 'functional_2.dcm']
382391
>>> converter.inputs.compression = 5

0 commit comments

Comments
 (0)