arpes.plotting.stack_plot.offset_scatter_plot

arpes.plotting.stack_plot.offset_scatter_plot(data, name_to_plot='', stack_axis='', ax=None, out='', scale_coordinate=0.5, ylim=(), fermi_level=None, loc='upper left', figsize=(11, 5), *, color='black', aux_errorbars=True, **kwargs)

Makes a stack plot (scatters version).

Parameters:

• data (xr.Dataset) – The dataset containing the data to plot.

• name_to_plot (str) – Name of the spectrum (in many case ‘spectrum’) to plot, by default “”.

• stack_axis (str) – The axis along which to stack the plot, by default “”.

• ax (Axes | None) – The axes on which to plot, by default None.

• out (str | Path) – The output path for the plot, by default “”.

• scale_coordinate (float) – The scale coordinate, by default 0.5

• ylim (tuple[float, float]) – The y-axis limits, by default ()

• fermi_level (float | None) – The Fermi level to draw the line, by default None (not drawn).

• figsize (tuple[float, float]) – The figure size, by default (11, 5)

• loc (LEGENDLOCATION) – The locatio of the legend, by default “upper left”.

• color – The color of the plot. Colormap can be set. Default to “black”.

• aux_errorbars (bool) – Whether to include auxiliary error bars, by default True

• kwargs – kwargs passing to args of Colorbar

Returns:

The path to the saved plot or the figure and axes.

Return type:

Path | tuple[Figure | None, Axes]

Raises:

ValueError –