xrheed.plotting.base

Functions

plot_image(rheed_image[, ax, auto_levels, ...])

Plot a RHEED image using matplotlib.

plot_image(rheed_image, ax=None, auto_levels=0.0, show_center_lines=True, show_specular_spot=False, **kwargs)[source]

Plot a RHEED image using matplotlib.

Parameters:
  • rheed_image (xr.DataArray) – The RHEED image to plot.

  • ax (matplotlib.axes.Axes or None, optional) – The axes to plot on. If None, a new figure and axes are created.

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

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

  • show_specular_spot (bool, optional) – If True, overlay the specularly reflected spot on the image.

  • **kwargs – Additional keyword arguments passed to xarray plot.

Returns:

The axes with the plotted image.

Return type:

matplotlib.axes.Axes