plot_data_overview

plot_data_overview(dataset: DatasetConvertible | Result, title: str = 'Data overview', linlog: bool = False, linthresh: float = 1, figsize: tuple[float, float] = (15, 10), nr_of_data_svd_vectors: int = 4, show_data_svd_legend: bool = True, irf_location: float | None = None, cmap: str = 'PuRd', vmin: float | None = None, vmax: float | None = None, svd_cycler: Cycler | None = cycler('color', [<ColorCode.black: '#000000'>, <ColorCode.red: '#ff0000'>, <ColorCode.blue: '#0000ff'>, <ColorCode.green: '#00ff00'>, <ColorCode.magenta: '#ff00ff'>, <ColorCode.cyan: '#00ffff'>, <ColorCode.yellow: '#ffff00'>, <ColorCode.green4: '#008b00'>, <ColorCode.orange: '#ff8c00'>, <ColorCode.brown: '#964b00'>, <ColorCode.grey: '#808080'>, <ColorCode.violet: '#9400d3'>, <ColorCode.turquoise: '#40e0d0'>, <ColorCode.maroon: '#800000'>, <ColorCode.indigo: '#4b0082'>]), use_svd_number: bool = False) → tuple[Figure, Axes] | tuple[Figure, Axis][source]

Plot data as filled contour plot and SVD components.

Parameters:

  • dataset (DatasetConvertible | Result) – Dataset containing data and SVD of the data.

  • title (str) – Title to add to the figure. Defaults to “Data overview”.

  • linlog (bool) – Whether to use ‘symlog’ scale or not. Defaults to False.

  • linthresh (float) – A single float which defines the range (-x, x), within which the plot is linear. This avoids having the plot go to infinity around zero. Defaults to 1.

  • figsize (tuple[float, float]) – Size of the figure (N, M) in inches. Defaults to (15, 10).

  • nr_of_data_svd_vectors (int) – Number of data SVD vector to plot. Defaults to 4.

  • show_data_svd_legend (bool) – Whether or not to show the data SVD legend. Defaults to True.

  • irf_location (float | None) – Location of the irf by which the time axis will get shifted. If it is None the time axis will not be shifted. Defaults to None.

  • cmap (str) – Colormap to use for the filled contour plot. Defaults to “PuRd” which is most suitable for emission data (previous default was “viridis”).

  • vmin (float | None) – Lower value to anchor the colormap. Defaults to None meaning it inferred from the data.

  • vmax (float | None) – Lower value to anchor the colormap. Defaults to None meaning it inferred from the data.

  • svd_cycler (Cycler | None) – Plot style cycler to use for SVD plots. Defaults to PlotStyle().cycler.

  • use_svd_number (bool) – Whether to use singular value number (starts at 1) instead of singular value index (starts at 0) for labeling in plot. Defaults to False.

Returns:

Figure and axes which can then be refined by the user.

Return type:

tuple[Figure, Axes] | tuple[Figure, Axis]