Merge pull request #894 from oesteban/enh/FreeSurferMRIPretess

enh: Freesurfer mri_pretess

Author: oesteban

CHANGES

@@ -1,6 +1,7 @@
 Next Release
 ============
 
+* ENH: New Freesurfer interface: MRIPretess
 * ENH: New miscelaneous interface: AddCSVRow
 * ENH: FUGUE interface has been refactored to use the name_template system, 3 examples 
        added to doctests, some bugs solved.

nipype/interfaces/freesurfer/__init__.py

@@ -10,6 +10,6 @@
 from .model import (MRISPreproc, GLMFit, OneSampleTTest, Binarize, Concatenate,
                     SegStats, Label2Vol, MS_LDA)
 from .utils import (SampleToSurface, SurfaceSmooth, SurfaceTransform, Surface2VolTransform,
-                    SurfaceSnapshots,ApplyMask, MRIsConvert, MRITessellate,
+                    SurfaceSnapshots,ApplyMask, MRIsConvert, MRITessellate, MRIPretess,
                     MRIMarchingCubes, SmoothTessellation, MakeAverageSubject,
                     ExtractMainComponent)

nipype/interfaces/freesurfer/tests/test_auto_MRIPretess.py

@@ -0,0 +1,56 @@
+# AUTO-GENERATED by tools/checkspecs.py - DO NOT EDIT
+from nipype.testing import assert_equal
+from nipype.interfaces.freesurfer.utils import MRIPretess
+
+def test_MRIPretess_inputs():
+    input_map = dict(args=dict(argstr='%s',
+    ),
+    environ=dict(nohash=True,
+    usedefault=True,
+    ),
+    ignore_exception=dict(nohash=True,
+    usedefault=True,
+    ),
+    in_filled=dict(argstr='%s',
+    mandatory=True,
+    position=-4,
+    ),
+    in_norm=dict(argstr='%s',
+    mandatory=True,
+    position=-2,
+    ),
+    keep=dict(argstr='-keep',
+    ),
+    label=dict(argstr='%s',
+    mandatory=True,
+    position=-3,
+    usedefault=True,
+    ),
+    nocorners=dict(argstr='-nocorners',
+    ),
+    out_file=dict(argstr='%s',
+    genfile=True,
+    position=-1,
+    ),
+    subjects_dir=dict(),
+    terminal_output=dict(mandatory=True,
+    nohash=True,
+    ),
+    test=dict(argstr='-test',
+    ),
+    )
+    inputs = MRIPretess.input_spec()
+
+    for key, metadata in input_map.items():
+        for metakey, value in metadata.items():
+            yield assert_equal, getattr(inputs.traits()[key], metakey), value
+
+def test_MRIPretess_outputs():
+    output_map = dict(out_file=dict(),
+    )
+    outputs = MRIPretess.output_spec()
+
+    for key, metadata in output_map.items():
+        for metakey, value in metadata.items():
+            yield assert_equal, getattr(outputs.traits()[key], metakey), value
+

nipype/interfaces/freesurfer/utils.py

@@ -923,6 +923,77 @@ def _gen_outfilename(self):
             _, name, ext = split_filename(self.inputs.in_file)
             return name + ext + '_' + str(self.inputs.label_value)
 
+
+class MRIPretessInputSpec(FSTraitedSpec):
+    in_filled = File(exists=True, mandatory=True, position=-4, argstr='%s',
+                     desc=('filled volume, usually wm.mgz'))
+    label = traits.Either(traits.Str('wm'), traits.Int(1), argstr='%s', default='wm',
+                          mandatory=True, usedefault=True, position=-3,
+                          desc=('label to be picked up, can be a Freesurfer\'s string like '
+                                '\'wm\' or a label value (e.g. 127 for rh or 255 for lh)'))
+    in_norm = File(exists=True, mandatory=True, position=-2, argstr='%s',
+                   desc=('the normalized, brain-extracted T1w image. Usually norm.mgz'))
+    out_file = File(position=-1, argstr='%s', genfile=True,
+                    desc=('the output file after mri_pretess.'))
+
+
+    nocorners = traits.Bool(False, argstr='-nocorners', desc=('do not remove corner configurations'
+                            ' in addition to edge ones.'))
+    keep = traits.Bool(False, argstr='-keep', desc=('keep WM edits'))
+    test = traits.Bool(False, argstr='-test', desc=('adds a voxel that should be removed by '
+                       'mri_pretess. The value of the voxel is set to that of an ON-edited WM, '
+                       'so it should be kept with -keep. The output will NOT be saved.'))
+
+class MRIPretessOutputSpec(TraitedSpec):
+    out_file = File(exists=True, desc='output file after mri_pretess')
+
+
+class MRIPretess(FSCommand):
+    """
+    Uses Freesurfer's mri_pretess to prepare volumes to be tessellated.
+
+    Description
+    -----------
+
+    Changes white matter (WM) segmentation so that the neighbors of all
+    voxels labeled as WM have a face in common - no edges or corners
+    allowed.
+
+    Example
+    -------
+
+    >>> import nipype.interfaces.freesurfer as fs
+    >>> pretess = fs.MRIPretess()
+    >>> pretess.inputs.in_filled = 'wm.mgz'
+    >>> pretess.inputs.in_norm = 'norm.mgz'
+    >>> pretess.inputs.nocorners = True
+    >>> pretess.cmdline
+    'mri_pretess -nocorners wm.mgz wm norm.mgz wm_pretesswm.mgz'
+    >>> pretess.run() # doctest: +SKIP
+    """
+    _cmd = 'mri_pretess'
+    input_spec = MRIPretessInputSpec
+    output_spec = MRIPretessOutputSpec
+
+    def _list_outputs(self):
+        outputs = self.output_spec().get()
+        outputs['out_file'] = os.path.abspath(self._gen_outfilename())
+        return outputs
+
+    def _gen_filename(self, name):
+        if name is 'out_file':
+            return self._gen_outfilename()
+        else:
+            return None
+
+    def _gen_outfilename(self):
+        if isdefined(self.inputs.out_file):
+            return self.inputs.out_file
+        else:
+            _, name, ext = split_filename(self.inputs.in_filled)
+            return name + '_pretess' + str(self.inputs.label) + ext
+
+
 class MRIMarchingCubesInputSpec(FSTraitedSpec):
     """
     Uses Freesurfer's mri_mc to create surfaces by tessellating a given input volume