hyperspy.drawing.image module

class hyperspy.drawing.image.ImagePlot

Bases: hyperspy.drawing.figure.BlittedFigure

property axes_ticks

configure()

connect()

create_axis()

create_figure(max_size=None, min_size=2, **kwargs)

Create matplotlib figure

The figure size is automatically computed by default, taking into account the x and y dimensions of the image. Alternatively the figure size can be defined by passing the figsize keyword argument.

Parameters

• min_size (max_size,) – The maximum and minimum size of the axes in inches. These have no effect when passing the figsize keyword to manually set the figure size.

• **kwargs – All keyword arguments are passed to plt.figure.

disconnect()

gui_adjust_contrast(display=True, toolkit=None)

Display widgets to adjust image contrast if available. :param display: If True, display the user interface widgets. If False, return the

widgets container in a dictionary, usually for customisation or testing.

Parameters

toolkit (str, iterable of strings or None) – If None (default), all available widgets are displayed or returned. If string, only the widgets of the selected toolkit are displayed if available. If an interable of toolkit strings, the widgets of all listed toolkits are displayed or returned.

on_key_press(event)

optimize_colorbar(number_of_ticks=5, tolerance=5, step_prec_max=1)

optimize_contrast(data, ignore_user_values=False)

plot(data_function_kwargs={}, **kwargs)

property scalebar

set_contrast(vmin, vmax)

set_quantity_label()

toggle_norm()

update(data_changed=True, **kwargs)

property vmax

property vmin