plot_irf_dispersion_center

plot_irf_dispersion_center(result: ResultLike, ax: Axis | None = None, figsize: tuple[float, float] = (12, 8), 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'>]), irf_location: float | None = None) → tuple[Figure, Axis] | None[source]

Plot the IRF dispersion center over the spectral dimension for one or multiple datasets.

Parameters:

  • result (ResultLike) – Data structure which can be converted to a mapping.

  • ax (Axis | None) – Axis to plot on. Defaults to None which means that a new figure and axis will be created.

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

  • cycler (Cycler | None) – Plot style cycler to use. Defaults to PlotStyle().cycler

  • 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.

Returns:

Figure object which contains the plots and the Axis, if ax is not None nothing will be returned.

Return type:

tuple[Figure, Axis] | None