xrheed.plotting.overview

Functions

plot_images(rheed_data[, ncols, fig_w, ...])

Plot multiple RHEED images in a grid layout.
plot_images(rheed_data, ncols=3, fig_w=3, auto_levels=0.0, show_center_lines=False, show_specular_spot=False, **kwargs)[source]

Plot multiple RHEED images in a grid layout.

Parameters:

  • rheed_data (xr.DataArray or list[xr.DataArray]) –

    Either:

    • A 3D stack (DataArray with one leading dimension, e.g. ‘alpha’),

    • A list of 2D RHEED images.

    Must contain more than one image.

  • ncols (int, optional) – Number of columns in the grid layout (default: 3).

  • fig_w (float, optional) – Width of single RHEED image (in)

  • auto_levels (float, optional) – If > 0, automatically set vmin/vmax for contrast enhancement (default: 0.0).

  • show_center_lines (bool, optional) – If True, show center lines at x=0 and y=0 (default: False).

  • show_specular_spot (bool, optional) – If True, show specular spot (default: False).

  • **kwargs – Additional keyword arguments passed to plot_image().

Returns:

The figure containing the plotted images.

Return type:

matplotlib.figure.Figure