Module: viewer¶

Bases: skimage.viewer.viewers.core.ImageViewer

Viewer for displaying image collections.

Select the displayed frame of the image collection using the slider or with the following keyboard shortcuts:

left/right arrows

Previous/next image in collection.

number keys, 0–9

0% to 90% of collection. For example, “5” goes to the image in the middle (i.e. 50%) of the collection.

home/end keys

First/last image in collection.

__init__(image_collection, update_on='move', **kwargs)[source]¶

keyPressEvent(event)[source]¶

update_index(name, index)[source]¶

Select image on display using index into image collection.

Bases: object

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.

Examples

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

Attributes

__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 = {'left': None, 'bottom': None, 'top': None, 'right': None}¶

image¶

open_file(filename=None)[source]¶

Open image file and display in viewer.

original_image_changed = None¶

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.