Skip to content

Commit 1fa5adb

Browse files
committed
DOC: Add doctests for fiddly ReconAll invocations
1 parent cf2a590 commit 1fa5adb

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

nipype/interfaces/freesurfer/preprocess.py

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -712,6 +712,37 @@ class ReconAll(CommandLine):
712712
>>> reconall.cmdline # doctest: +ALLOW_UNICODE
713713
'recon-all -all -i structural.nii -subjid foo -sd .'
714714
715+
Hemisphere may be specified regardless of directive:
716+
717+
>>> reconall.inputs.hemi = 'lh'
718+
>>> reconall.cmdline # doctest: +ALLOW_UNICODE
719+
'recon-all -all -i structural.nii -hemi lh -subjid foo -sd .'
720+
721+
``-autorecon-hemi`` uses the ``-hemi`` input to specify the hemisphere
722+
to operate upon:
723+
724+
>>> reconall.inputs.directive = 'autorecon-hemi'
725+
>>> reconall.cmdline # doctest: +ALLOW_UNICODE
726+
'recon-all -autorecon-hemi lh -i structural.nii -subjid foo -sd .'
727+
728+
Hippocampal subfields can accept T1 and T2 images:
729+
730+
>>> reconall_subfields = ReconAll()
731+
>>> reconall_subfields.inputs.subject_id = 'foo'
732+
>>> reconall_subfields.inputs.directive = 'all'
733+
>>> reconall_subfields.inputs.subjects_dir = '.'
734+
>>> reconall_subfields.inputs.T1_files = 'structural.nii'
735+
>>> reconall_subfields.inputs.hippocampal_subfields_T1 = True
736+
>>> reconall_subfields.cmdline # doctest: +ALLOW_UNICODE
737+
'recon-all -all -i structural.nii -subjid foo -hippocampal-subfields-T1 -sd .'
738+
>>> reconall_subfields.inputs.hippocampal_subfields_T2 = (
739+
... 'structural.nii', 'test')
740+
>>> reconall_subfields.cmdline # doctest: +ALLOW_UNICODE
741+
'recon-all -all -i structural.nii -subjid foo -hippocampal-subfields-T1T2 structural.nii test -sd .'
742+
>>> reconall_subfields.inputs.hippocampal_subfields_T1 = False
743+
>>> reconall_subfields.cmdline # doctest: +ALLOW_UNICODE
744+
'recon-all -all -i structural.nii -subjid foo -hippocampal-subfields-T2 structural.nii test -sd .'
745+
715746
"""
716747

717748
_cmd = 'recon-all'

0 commit comments

Comments
 (0)