Added MultipleSelectInterface

Author: oesteban

nipype/interfaces/tests/test_auto_MultipleSelectInterface.py

@@ -0,0 +1,25 @@
+# AUTO-GENERATED by tools/checkspecs.py - DO NOT EDIT
+from nipype.testing import assert_equal
+from nipype.interfaces.utility import MultipleSelectInterface
+
+def test_MultipleSelectInterface_inputs():
+    input_map = dict(ignore_exception=dict(nohash=True,
+    usedefault=True,
+    ),
+    index=dict(mandatory=True,
+    ),
+    )
+    inputs = MultipleSelectInterface.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_MultipleSelectInterface_outputs():
+    output_map = dict()
+    outputs = MultipleSelectInterface.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/utility.py

@@ -551,3 +551,63 @@ def _list_outputs(self):
                 outputs[key].append(val)
 
         return outputs
+
+
+class MultipleSelectInputSpec(BaseInterfaceInputSpec, DynamicTraitedSpec):
+    index = InputMultiPath(traits.Int, mandatory=True,
+                           desc='0-based indices of values to choose')
+
+class MultipleSelectInterface(IdentityInterface):
+    """
+    Basic interface that demultiplexes lists generated by CollateInterface
+
+    Example
+    -------
+
+    >>> from nipype.interfaces.utility import MultipleSelectInterface
+    >>> demux = MultipleSelectInterface(fields=['file','miscdata'], index=0)
+    >>> demux.inputs.file = ['exfile1.csv', 'exfile2.csv']
+    >>> demux.inputs.miscdata = [1.0, 2.0]
+    >>> res = demux.run()
+    >>> print res.outputs.file
+    exfile1.csv
+    >>> print res.outputs.miscdata
+    1.0
+    """
+    input_spec = MultipleSelectInputSpec
+    output_spec = DynamicTraitedSpec
+
+    def __init__(self, fields=None, mandatory_inputs=True, **inputs):
+        super(IdentityInterface, self).__init__(**inputs)
+        if fields is None or not fields:
+            raise ValueError('Identity Interface fields must be a non-empty list')
+        # Each input must be in the fields.
+        for in_field in inputs:
+            if in_field not in fields and in_field != 'index':
+                raise ValueError('Identity Interface input is not in the fields: %s' % in_field)
+        self._fields = fields
+        self._mandatory_inputs = mandatory_inputs
+        add_traits(self.inputs, fields)
+        # Adding any traits wipes out all input values set in superclass initialization,
+        # even it the trait is not in the add_traits argument. The work-around is to reset
+        # the values after adding the traits.
+        self.inputs.set(**inputs)
+
+    def _list_outputs(self):
+        #manual mandatory inputs check
+        if self._fields and self._mandatory_inputs:
+            for key in self._fields:
+                value = getattr(self.inputs, key)
+                if not isdefined(value):
+                    msg = "%s requires a value for input '%s' because it was listed in 'fields'. \
+                    You can turn off mandatory inputs checking by passing mandatory_inputs = False to the constructor." % \
+                    (self.__class__.__name__, key)
+                    raise ValueError(msg)
+
+        outputs = self._outputs().get()
+        for key in self._fields:
+            val = getattr(self.inputs, key)
+            if isdefined(val):
+                outputs[key] = np.squeeze(np.array(val)[np.array(self.inputs.index)]).tolist()
+        return outputs
+