adgtk.utils.plotting

Built-in plotting utilities for ADGTK.

adgtk.utils.plotting.plot_single_line(data: Sequence, filename: str, data_label: str = '', title: str = '', x_label: str = '', y_label: str = '', show_legend: bool = False) bool

Plots a single line. basic plotting only

Parameters:
  • data (Sequence) – the data to plot on th Y axis

  • filename (str) – the filename to save the image to

  • data_label (str, optional) – if using a legend what is the data label, defaults to “”

  • title (str, optional) – Title for the plot, defaults to “”

  • x_label (str, optional) – label for the X-axis, defaults to “”

  • y_label (str, optional) – label for the Y-axis, defaults to “”

  • show_legend (bool, optional) – show the legend?, defaults to False

Returns:

True if plot attempted.

Return type:

bool