Skip to content

Commit a3d2b06

Browse files
committed
DOC: Add doctests for fiddly ReconAll invocations
1 parent c8bae35 commit a3d2b06

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

nipype/interfaces/freesurfer/preprocess.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -717,6 +717,38 @@ class ReconAll(CommandLine):
717717
>>> reconall.inputs.flags = ["-cw256", "-qcache"]
718718
>>> reconall.cmdline # doctest: +ALLOW_UNICODE
719719
'recon-all -all -i structural.nii -cw256 -qcache -subjid foo -sd .'
720+
721+
Hemisphere may be specified regardless of directive:
722+
723+
>>> reconall.inputs.flags = []
724+
>>> reconall.inputs.hemi = 'lh'
725+
>>> reconall.cmdline # doctest: +ALLOW_UNICODE
726+
'recon-all -all -i structural.nii -hemi lh -subjid foo -sd .'
727+
728+
``-autorecon-hemi`` uses the ``-hemi`` input to specify the hemisphere
729+
to operate upon:
730+
731+
>>> reconall.inputs.directive = 'autorecon-hemi'
732+
>>> reconall.cmdline # doctest: +ALLOW_UNICODE
733+
'recon-all -autorecon-hemi lh -i structural.nii -subjid foo -sd .'
734+
735+
Hippocampal subfields can accept T1 and T2 images:
736+
737+
>>> reconall_subfields = ReconAll()
738+
>>> reconall_subfields.inputs.subject_id = 'foo'
739+
>>> reconall_subfields.inputs.directive = 'all'
740+
>>> reconall_subfields.inputs.subjects_dir = '.'
741+
>>> reconall_subfields.inputs.T1_files = 'structural.nii'
742+
>>> reconall_subfields.inputs.hippocampal_subfields_T1 = True
743+
>>> reconall_subfields.cmdline # doctest: +ALLOW_UNICODE
744+
'recon-all -all -i structural.nii -subjid foo -hippocampal-subfields-T1 -sd .'
745+
>>> reconall_subfields.inputs.hippocampal_subfields_T2 = (
746+
... 'structural.nii', 'test')
747+
>>> reconall_subfields.cmdline # doctest: +ALLOW_UNICODE
748+
'recon-all -all -i structural.nii -subjid foo -hippocampal-subfields-T1T2 structural.nii test -sd .'
749+
>>> reconall_subfields.inputs.hippocampal_subfields_T1 = False
750+
>>> reconall_subfields.cmdline # doctest: +ALLOW_UNICODE
751+
'recon-all -all -i structural.nii -subjid foo -hippocampal-subfields-T2 structural.nii test -sd .'
720752
"""
721753

722754
_cmd = 'recon-all'

0 commit comments

Comments
 (0)