WIP: A lightweight UI for medical visualizations based on VTK-Python

.gitignore

@@ -29,3 +29,5 @@ __config__.py
 .coverage
 .buildbot.patch
 .eggs/
+
+.idea/

.travis.yml

@@ -37,6 +37,7 @@ matrix:
     - python: 2.7
       sudo: true   # This is set to true for apt-get
       env:
+        - COVERAGE=1
         - VTK=1
         - VTK_VER="python-vtk"
         - LIBGL_ALWAYS_INDIRECT=y

dipy/testing/decorators.py

@@ -60,12 +60,12 @@ def xvfb_it(my_test):
     # When we use verbose testing we want the name:
     fname = my_test.__name__
 
-    def test_with_xvfb():
+    def test_with_xvfb(*args, **kwargs):
         if use_xvfb:
             from xvfbwrapper import Xvfb
             display = Xvfb(width=1920, height=1080)
             display.start()
-        my_test()
+        my_test(*args, **kwargs)
         if use_xvfb:
             display.stop()
     # Plant it back in and return the new function:

dipy/viz/gui.py

@@ -0,0 +1,214 @@
+from dipy.viz.interactor import CustomInteractorStyle
+
+from dipy.utils.optpkg import optional_package
+
+# Allow import, but disable doctests if we don't have vtk.
+vtk, have_vtk, setup_module = optional_package('vtk')
+
+if have_vtk:
+    version = vtk.vtkVersion.GetVTKSourceVersion().split(' ')[-1]
+    major_version = vtk.vtkVersion.GetVTKMajorVersion()
+else:
+    vtkInteractorStyleUser = object
+
+
+class UI(object):
+    """ An umbrella class for all UI elements.
+
+    While adding UI elements to the renderer, we need to go over all the
+     sub-elements that come with it and add those to the renderer too.
+    There are several features that are common to all the UI elements:
+    - ui_param : This is an attribute that can be passed to the UI object
+                by the interactor. Thanks to Python's dynamic type-setting
+                this parameter can be anything.
+    - ui_list : This is used when there are more than one UI elements inside
+               a UI element. Inside the renderer, they're all iterated and added.
+    - parent_UI: This is useful of there is a parent UI element and its reference
+                needs to be passed down to the child.
+
+    """
+    def __init__(self):
+        self.ui_param = None
+        self.ui_list = list()
+
+        self.parent_UI = None
+        self._callbacks = []
+
+    def get_actors(self):
+        """ Returns the actors that compose this UI component. """
+        msg = "Subclasses of UI must implement `get_actors(self)`."
+        raise NotImplementedError(msg)
+
+    def add_to_renderer(self, ren):
+        """ Allows UI objects to add their own props to the renderer.
+
+        Parameters
+        ----------
+        ren : renderer
+        """
+        ren.add(*self.get_actors())
+
+        # Get a hold on the current interactor style.
+        iren = ren.GetRenderWindow().GetInteractor().GetInteractorStyle()
+
+        for callback in self._callbacks:
+            if not isinstance(iren, CustomInteractorStyle):
+                msg = ("The ShowManager requires `CustomInteractorStyle` in"
+                       " order to use callbacks.")
+                raise TypeError(msg)
+
+            iren.add_callback(*callback, args=[self])
+
+    def add_callback(self, prop, event_type, callback, priority=0):
+        """ Adds a callback to a specific event for this UI component.
+
+        Parameters
+        ----------
+        prop : vtkProp
+        event_type : event code
+        callback : function
+        priority : int
+        """
+        # Actually since we need an interactor style we will add the callback
+        # only when this UI component is added to the renderer.
+        self._callbacks.append((prop, event_type, callback, priority))
+
+    def set_center(self, position):
+        """ Sets the center of the UI component
+
+        Parameters
+        ----------
+        position : (float, float)
+        """
+        pass
+
+
+class TextActor2D(vtk.vtkTextActor):
+    """ Inherits from the default vtkTextActor and helps setting the text.
+
+    Contains member functions for text formatting.
+    """
+    def message(self, text):
+        """ Set message after initialization.
+
+        Parameters
+        ----------
+        text : string
+
+        """
+        self.SetInput(text)
+
+    def set_message(self, text):
+        """ Modify text message.
+
+        Parameters
+        ----------
+        text : string
+        """
+        self.SetInput(text)
+
+    def get_message(self):
+        """ Gets message from the text.
+
+        Returns
+        -------
+        message : string
+
+        """
+        return self.GetInput()
+
+    def font_size(self, size):
+        """ Sets font size.
+
+        Parameters
+        ----------
+        size : int
+        """
+        self.GetTextProperty().SetFontSize(size)
+
+    def font_family(self, family='Arial'):
+        """ Sets font family.
+        Currently defaults to Ariel.
+        # TODO: Add other font families.
+
+        Parameters
+        ----------
+        family : string
+        """
+        self.GetTextProperty().SetFontFamilyToArial()
+
+    def justification(self, justification):
+        """ Justifies text.
+
+        Parameters
+        ----------
+        justification : string
+            Possible values : left, right, center
+        """
+        tprop = self.GetTextProperty()
+        if justification == 'left':
+            tprop.SetJustificationToLeft()
+        if justification == 'center':
+            tprop.SetJustificationToCentered()
+        if justification == 'right':
+            tprop.SetJustificationToRight()
+
+    def font_style(self, bold=False, italic=False, shadow=False):
+        """ Style font.
+
+        Parameters
+        ----------
+        bold : bool
+        italic : bool
+        shadow : bool
+        """
+        tprop = self.GetTextProperty()
+        if bold:
+            tprop.BoldOn()
+        else:
+            tprop.BoldOff()
+        if italic:
+            tprop.ItalicOn()
+        else:
+            tprop.ItalicOff()
+        if shadow:
+            tprop.ShadowOn()
+        else:
+            tprop.ShadowOff()
+
+    def color(self, color=(1, 0, 0)):
+        """ Set text color.
+
+        Parameters
+        ----------
+        color : (float, float, float)
+            Values must be between 0-1
+        """
+        self.GetTextProperty().SetColor(*color)
+
+    def set_position(self, position):
+        """ Set text actor position.
+
+        Parameters
+        ----------
+        position : (float, float)
+        """
+        self.SetDisplayPosition(*position)
+
+    def get_position(self):
+        """ Gets text actor position.
+
+        Returns
+        -------
+        position : (float, float)
+        """
+        return self.GetDisplayPosition()
+
+    def set_center(self, position):
+        """ Set text actor position.
+
+        Parameters
+        ----------
+        position : (float, float)
+        """
+        self.SetPosition(position)