arpes.plotting.stack_plot.flat_stack_plot#

arpes.plotting.stack_plot.flat_stack_plot(data, *, stack_axis='', ax=None, mode='line', fermi_level=None, figsize=(7, 5), title='', max_stacks=200, out='', loc='upper left', **kwargs)[source]#

Generates a stack plot with all the lines distinguished by color rather than offset.

Parameters:
  • data (DataType) – ARPES data (xr.DataArray is prepfered)

  • stack_axis (str) – axis for stacking, by default “”

  • ax (Axes | None) – matplotlib Axes, by default None.j

  • mode (Literal["line", "scatter"]) – plot style (line/sckatter), by default “line”.

  • fermi_level (float|None) – Value of the Fermi level to Draw the line, by default None.

  • figsize (tuple[float, float]) – Figure size, by default (7, 5).

  • title (str) – Title string, by default “”

  • max_stacks (int) – Maximum number of the staking spectra, by default 200.

  • out (str | Path) – Path to the figure, by default “”.

  • loc (LEGENDLOCATION) – Legend location, by default “upper left”.

  • **kwargs – Additional keyword to pass to ax.plot

Returns:

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

Return type:

Path | tuple[Figure | None, Axes]

Raises:
  • ValueError – If there is an issue with the input data.

  • NotImplementedError – If a feature is not implemented.