ENH: Better tests

Author: larsoner

nibabel/spatialimages.py

@@ -663,20 +663,18 @@ def __getitem__(self):
                         "array data with `img.dataobj[slice]` or "
                         "`img.get_data()[slice]`")
 
-    def plot(self, show=True):
+    def plot(self):
         """Plot the image using OrthoSlicer3D
 
-        Parameters
-        ----------
-        show : bool
-            If True, the viewer will be shown.
-
         Returns
         -------
         viewer : instance of OrthoSlicer3D
             The viewer.
+
+        Notes
+        -----
+        This requires matplotlib. If a non-interactive backend is used,
+        consider using viewer.show() (equivalently plt.show()) to show
+        the figure.
         """
-        out = OrthoSlicer3D(self.get_data())
-        if show:
-            out.show()
-        return out
+        return OrthoSlicer3D(self.get_data())

nibabel/tests/test_viewers.py

@@ -26,28 +26,39 @@ def test_viewer():
     # Test viewer
     a = np.sin(np.linspace(0, np.pi, 20))
     b = np.sin(np.linspace(0, np.pi*5, 30))
-    data = np.outer(a, b)[..., np.newaxis] * a
+    data = (np.outer(a, b)[..., np.newaxis] * a)[:, :, :, np.newaxis]
     viewer = OrthoSlicer3D(data)
     plt.draw()
 
-    # fake some events
-    viewer.on_scroll(nt('event', 'button inaxes')('up', None))  # outside axes
-    viewer.on_scroll(nt('event', 'button inaxes')('up', plt.gca()))  # in axes
+    # fake some events, inside and outside axes
+    viewer._on_scroll(nt('event', 'button inaxes key')('up', None, None))
+    for ax in (viewer._axes['x'], viewer._axes['v']):
+        viewer._on_scroll(nt('event', 'button inaxes key')('up', ax, None))
+    viewer._on_scroll(nt('event', 'button inaxes key')('up', ax, 'shift'))
     # "click" outside axes, then once in each axis, then move without click
-    viewer.on_mousemove(nt('event', 'xdata ydata inaxes button')(0.5, 0.5,
-                                                                 None, 1))
-    for im in viewer._ims:
-        viewer.on_mousemove(nt('event', 'xdata ydata inaxes button')(0.5, 0.5,
-                                                                     im.axes,
-                                                                     1))
-    viewer.on_mousemove(nt('event', 'xdata ydata inaxes button')(0.5, 0.5,
-                                                                 None, None))
+    viewer._on_mousemove(nt('event', 'xdata ydata inaxes button')(0.5, 0.5,
+                                                                  None, 1))
+    for ax in viewer._axes.values():
+        viewer._on_mousemove(nt('event', 'xdata ydata inaxes button')(0.5, 0.5,
+                                                                      ax, 1))
+    viewer._on_mousemove(nt('event', 'xdata ydata inaxes button')(0.5, 0.5,
+                                                                  None, None))
     viewer.set_indices(0, 1, 2)
+    viewer.set_indices(v=10)
     viewer.close()
 
+    # non-multi-volume
+    viewer = OrthoSlicer3D(data[:, :, :, 0])
+    assert_raises(ValueError, viewer.set_indices, v=10)  # not multi-volume
+    viewer._on_scroll(nt('event', 'button inaxes key')('up', viewer._axes['x'],
+                                                       'shift'))
+    viewer._on_keypress(nt('event', 'key')('escape'))
+
     # other cases
-    fig, axes = plt.subplots(1, 3)
+    fig, axes = plt.subplots(1, 4)
     plt.close(fig)
-    OrthoSlicer3D(data, pcnt_range=[0.1, 0.9], axes=axes)
-    assert_raises(ValueError, OrthoSlicer3D, data, aspect_ratio=[1, 2, 3],
-                  axes=axes)
+    OrthoSlicer3D(data, pcnt_range=[0.1, 0.9], axes=axes,
+                  aspect_ratio=[1, 2, 3])
+    OrthoSlicer3D(data, axes=axes[:3])
+    assert_raises(ValueError, OrthoSlicer3D, data, aspect_ratio=[1, 2])
+    assert_raises(ValueError, OrthoSlicer3D, data[:, :, 0, 0])

nibabel/viewers.py

@@ -11,6 +11,7 @@
 
 plt, _, _ = optional_package('matplotlib.pyplot')
 mpl_img, _, _ = optional_package('matplotlib.image')
+mpl_patch, _, _ = optional_package('matplotlib.patches')
 
 
 class OrthoSlicer3D(object):
@@ -61,7 +62,7 @@ def __init__(self, data, axes=None, aspect_ratio=(1, 1, 1), cmap='gray',
         aspect_ratio = dict(x=ar[0], y=ar[1], z=ar[2])
         data = np.asanyarray(data)
         if data.ndim < 3:
-            raise RuntimeError('data must have at least 3 dimensions')
+            raise ValueError('data must have at least 3 dimensions')
         self._volume_dims = data.shape[3:]
         self._current_vol_data = data[:, :, :, 0] if data.ndim > 3 else data
         self._data = data
@@ -147,20 +148,23 @@ def __init__(self, data, axes=None, aspect_ratio=(1, 1, 1), cmap='gray',
             ax.axes.get_xaxis().set_visible(False)
 
         # Set up volumes axis
-        if self.multi_volume:
+        if self.multi_volume and 'v' in self._axes:
             ax = self._axes['v']
             ax.set_axis_bgcolor('k')
             ax.set_title('Volumes')
             n_vols = np.prod(self._volume_dims)
-            print(n_vols)
             y = np.mean(np.mean(np.mean(self._data, 0), 0), 0).ravel()
             y = np.concatenate((y, [y[-1]]))
             x = np.arange(n_vols + 1) - 0.5
             step = ax.step(x, y, where='post', color='y')[0]
             ax.set_xticks(np.unique(np.linspace(0, n_vols - 1, 5).astype(int)))
             ax.set_xlim(x[0], x[-1])
-            line = ax.plot([0, 0], ax.get_ylim(), color=(0, 1, 0))[0]
-            self._time_lines = [line, step]
+            lims = ax.get_ylim()
+            patch = mpl_patch.Rectangle([-0.5, lims[0]], 1., np.diff(lims)[0],
+                                       fill=True, facecolor=(0, 1, 0),
+                                       edgecolor=(0, 1, 0), alpha=0.25)
+            ax.add_patch(patch)
+            self._time_lines = [patch, step]
 
         # setup pairwise connections between the slice dimensions
         self._click_update_keys = dict(x='yz', y='xz', z='xy')
@@ -180,11 +184,9 @@ def __init__(self, data, axes=None, aspect_ratio=(1, 1, 1), cmap='gray',
             fig.canvas.mpl_connect('motion_notify_event', self._on_mousemove)
             fig.canvas.mpl_connect('button_press_event', self._on_mousemove)
             fig.canvas.mpl_connect('key_press_event', self._on_keypress)
-        plt.draw()
-        self._draw()
 
     def show(self):
-        """ Show the slicer; convenience for ``plt.show()``
+        """ Show the slicer in blocking mode; convenience for ``plt.show()``
         """
         plt.show()
 
@@ -220,8 +222,8 @@ def set_indices(self, x=None, y=None, z=None, v=None):
         draw = False
         if v is not None:
             if not self.multi_volume:
-                raise RuntimeError('cannot change volume index of '
-                                   'single-volume image')
+                raise ValueError('cannot change volume index of single-volume '
+                                 'image')
             self._set_vol_idx(v, draw=False)  # delay draw
             draw = True
         for key, val in zip('zyx', (z, y, x)):
@@ -239,7 +241,7 @@ def _set_vol_idx(self, idx, draw=True):
         self._current_vol_data = self._data[:, :, :, self._idx['v']]
         for key in 'xyz':
             self._ims[key].set_data(self._get_slice(key))
-        self._time_lines[0].set_xdata([self._idx['v']] * 2)
+        self._time_lines[0].set_x(self._idx['v'] - 0.5)
         if draw:
             self._draw()
 
@@ -262,7 +264,6 @@ def _in_axis(self, event):
         for key, ax in self._axes.items():
             if event.inaxes is ax:
                 return key
-        return None
 
     def _on_scroll(self, event):
         assert event.button in ('up', 'down')
@@ -309,7 +310,7 @@ def _draw(self):
             ax.figure.canvas.blit(ax.bbox)
             for t in im.texts:
                 ax.draw_artist(t)
-        if self.multi_volume:
+        if self.multi_volume and 'v' in self._axes:  # user might only pass 3
             ax = self._axes['v']
             ax.draw_artist(ax.patch)
             for artist in self._time_lines: