Skip to content

fix: undeprecate dcm2niix source_names option #2550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions nipype/interfaces/dcm2nii.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,15 +263,18 @@ class Dcm2niixInputSpec(CommandLineInputSpec):
argstr="%s",
position=-1,
copyfile=False,
deprecated='1.0.2',
new_name='source_dir',
mandatory=True,
desc=('A set of filenames to be converted. Note that the current '
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably specify the latest as being 1.0.20180328 in case this behavior changes down the line

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

roger

'version (1.0.20180328) of dcm2niix converts any files in the '
'directory. To only convert specific files they should be in an '
'isolated directory'),
xor=['source_dir'])
source_dir = Directory(
exists=True,
argstr="%s",
position=-1,
mandatory=True,
desc='A directory containing dicom files to be converted',
xor=['source_names'])
out_filename = traits.Str(
argstr="-f %s",
Expand Down Expand Up @@ -378,6 +381,18 @@ class Dcm2niix(CommandLine):
>>> converter.cmdline
'dcm2niix -b y -z y -5 -x n -t n -m n -o ds005 -s n -v n dicomdir'
>>> converter.run() # doctest: +SKIP

# In the example below, we note that the current version of dcm2niix
# converts any files in the directory containing the files in the list. We
# also do not support nested filenames with this option. Thus all files
# should have a common root directory.
>>> converter = Dcm2niix()
>>> converter.inputs.source_names = ['functional_1.dcm', 'functional_2.dcm']
>>> converter.inputs.compression = 5
>>> converter.inputs.output_dir = 'ds005'
>>> converter.cmdline
'dcm2niix -b y -z y -5 -x n -t n -m n -o ds005 -s n -v n .'
>>> converter.run() # doctest: +SKIP
"""

input_spec = Dcm2niixInputSpec
Expand All @@ -399,7 +414,7 @@ def _format_arg(self, opt, spec, val):
spec.argstr += ' n'
val = True
if opt == 'source_names':
return spec.argstr % val[0]
return spec.argstr % (os.path.dirname(val[0]) or '.')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since the dicoms are copied to the node, couldn't this just be '.'

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not when used as an interface.

return super(Dcm2niix, self)._format_arg(opt, spec, val)

def _run_interface(self, runtime):
Expand Down
2 changes: 0 additions & 2 deletions nipype/interfaces/tests/test_auto_Dcm2niix.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,7 @@ def test_Dcm2niix_inputs():
source_names=dict(
argstr='%s',
copyfile=False,
deprecated='1.0.2',
mandatory=True,
new_name='source_dir',
position=-1,
xor=['source_dir'],
),
Expand Down