imageviewer

ImageViewer

class skimage.viewer.viewers.ImageViewer(image, useblit=True) [source]

Bases: PyQt4.QtGui.QMainWindow

Viewer for displaying images.

This viewer is a simple container object that holds a Matplotlib axes for showing images. ImageViewer doesn’t subclass the Matplotlib axes (or figure) because of the high probability of name collisions.

Subclasses and plugins will likely extend the update_image method to add custom overlays or filter the displayed image.

Parameters:	image : array Image being viewed.

Examples

>>> from skimage import data
>>> image = data.coins()
>>> viewer = ImageViewer(image) 
>>> viewer.show()               

Attributes

canvas, fig, ax	(Matplotlib canvas, figure, and axes) Matplotlib canvas, figure, and axes used to display image.
image	(array) Image being viewed. Setting this value will update the displayed frame.
original_image	(array) Plugins typically operate on (but don’t change) the original image.
plugins	(list) List of attached plugins.

__init__(image, useblit=True) [source]

add_tool(tool) [source]

closeEvent(event) [source]

connect_event(event, callback) [source]

Connect callback function to matplotlib event and return id.

disconnect_event(callback_id) [source]

Disconnect callback by its id (returned by connect_event).

dock_areas = {'top': 4, 'left': 1, 'right': 2, 'bottom': 8}

image

open_file(filename=None) [source]

Open image file and display in viewer.

original_image_changed

redraw() [source]

remove_tool(tool) [source]

reset_image() [source]

save_to_file(filename=None) [source]

Save current image to file.

The current behavior is not ideal: It saves the image displayed on screen, so all images will be converted to RGB, and the image size is not preserved (resizing the viewer window will alter the size of the saved image).

show(main_window=True) [source]

Show ImageViewer and attached plugins.

This behaves much like matplotlib.pyplot.show and QWidget.show.

update_image(image) [source]

Update displayed image.

This method can be overridden or extended in subclasses and plugins to react to image changes.