arpes.plotting.false_color.false_color_plot#

arpes.plotting.false_color.false_color_plot(data_rgb, ax=None, out='', *, invert=False, pmin_pmax=(0, 1), figsize=(7, 5))[source]#

Plots a spectrum in false color after conversion to R, G, B arrays.

Parameters:
  • data_rgb (tuple[xr.Dataset, xr.Dataset, xr.Dataset]) – Tuple containing the R, G, B datasets.

  • ax (Axes | None, optional) – Matplotlib Axes object. If None, a new figure and axes are created.

  • out (str | Path, optional) – Path to save the plot. If empty, the plot is not saved.

  • invert (bool, optional) – If True, inverts the colors in the HSV space.

  • pmin_pmax (tuple[float, float], optional) – Percentile range for normalization.

  • figsize (tuple[float, float], optional) – Size of the figure if a new one is created.

Returns:

If out is specified, returns the path where the plot is saved. tuple[Figure | None, Axes]: If out is not specified, returns the figure and axes objects.

Return type:

Path