Files
scikit-image/skimage/viewer/plugins/base.py
T
Tony S Yu bc6c81606f Fix add_argument.
`arguments` is a list, but I was treating it like a dict.
2012-07-22 01:25:58 -04:00

126 lines
4.3 KiB
Python

from PyQt4 import QtGui
import matplotlib as mpl
from skimage.io._plugins.q_color_mixer import IntelligentSlider
class Plugin(QtGui.QDialog):
"""Base class for widgets that interact with the axes.
Parameters
----------
image_viewer : ImageViewer instance.
Window containing image used in measurement/manipulation.
callback : function
Function that gets called to update ImageViewer. Alternatively, this
can also be defined as a method in a Plugin subclass.
height, width : int
Size of plugin window in pixels.
useblit : bool
If True, use blitting to speed up animation. Only available on some
backends. If None, set to True when using Agg backend, otherwise False.
Attributes
----------
image_viewer : ImageViewer
Window containing image used in measurement.
image : array
Image used in measurement/manipulation.
"""
name = 'Plugin'
draws_on_image = False
def __init__(self, image_viewer, callback=None, height=100, width=400,
useblit=None):
self.image_viewer = image_viewer
QtGui.QDialog.__init__(self, image_viewer)
self.image_viewer.plugins.append(self)
self.setWindowTitle(self.name)
self.layout = QtGui.QGridLayout(self)
self.resize(width, height)
self.row = 0
if callback is not None:
self.callback = callback
self.arguments = [image_viewer.original_image]
self.keyword_arguments= {}
self.image = self.image_viewer.image
if useblit is None:
useblit = True if mpl.backends.backend.endswith('Agg') else False
self.useblit = useblit
self.cids = []
self.artists = []
if self.draws_on_image:
self.connect_event('draw_event', self.on_draw)
def on_draw(self, event):
"""Save image background when blitting.
The saved image is used to "clear" the figure before redrawing artists.
"""
if self.useblit:
bbox = self.image_viewer.ax.bbox
self.img_background = self.image_viewer.canvas.copy_from_bbox(bbox)
def caller(self, *args):
arguments = [self._get_value(a) for a in self.arguments]
kwargs = dict([(name, self._get_value(a))
for name, a in self.keyword_arguments.iteritems()])
self.callback(*arguments, **kwargs)
def _get_value(self, param):
if hasattr(param, 'val'):
return param.val()
else:
return param
def add_argument(self, name, low, high, callback, **kwargs):
name, slider = self.add_slider(name, low, high, callback, **kwargs)
self.arguments.append(slider)
def add_keyword_argument(self, name, low, high, callback, **kwargs):
name, slider = self.add_slider(name, low, high, callback, **kwargs)
self.keyword_arguments[name] = slider
def add_slider(self, name, low, high, callback, **kwargs):
slider = IntelligentSlider(name, low, high, callback,
orientation='horizontal', **kwargs)
self.layout.addWidget(slider, self.row, 0)
self.row += 1
return name.replace(' ', '_'), slider
def closeEvent(self, event):
"""Disconnect all artists and events from ImageViewer.
Note that events must be connected using `self.connect_event` and
artists must be appended to `self.artists`.
"""
self.disconnect_image_events()
self.remove_artists()
self.image_viewer.plugins.remove(self)
self.image_viewer.redraw()
self.close()
def connect_event(self, event, callback):
"""Connect callback with an event.
This should be used in lieu of `figure.canvas.mpl_connect` since this
function stores call back ids for later clean up.
"""
cid = self.image_viewer.connect_event(event, callback)
self.cids.append(cid)
def disconnect_image_events(self):
"""Disconnect all events created by this widget."""
for c in self.cids:
self.image_viewer.disconnect_event(c)
def remove_artists(self):
"""Disconnect artists that are connected to the *image plot*."""
for a in self.artists:
self.image_viewer.remove_artist(a)