plot_coherent_artifact

plot_coherent_artifact(dataset: DatasetConvertible | Result, *, time_range: tuple[float, float] | None = None, spectral: float = 0, main_irf_nr: int | None = 0, normalize: bool = True, figsize: tuple[float, float] = (18, 7), show_zero_line: bool = True, cycler: Cycler | None = None, title: str | None = 'Coherent Artifact') → tuple[Figure, Axes][source]

Plot coherent artifact as IRF derivative components over time and IRFAS over spectral dim.

The IRFAS are the IRF (Instrument Response Function) Associated Spectra.

Parameters:

dataset (DatasetConvertible | Result) – Result dataset from a pyglotaran optimization.
time_range (tuple[float, float] | None) – Start and end time for the IRF derivative plot. Defaults to None which means that the full time range is used.
spectral (float) – Value of the spectral axis that should be used to select the data for the IRF derivative plot this value does not need to be an exact existing value and only has effect if the IRF has dispersion. Defaults to 0 which means that the IRF derivative plot at lowest spectral value will be shown.
main_irf_nr (int | None) – Index of the main irf component when using an irf parametrized with multiple peaks and is used to shift the time axis. If it is none None the shifting will be deactivated. Defaults to 0.
normalize (bool) – Whether or not to normalize the IRF derivative plot. If the IRF derivative is normalized, the IRFAS is scaled with the reciprocal of the normalization to compensate for this. Defaults to True.
figsize (tuple[float, float]) – Size of the figure (N, M) in inches. Defaults to (18, 7).
show_zero_line (bool) – Whether or not to add a horizontal line at zero. Defaults to True.
cycler (Cycler | None) – Plot style cycler to use. Defaults to None, which means that the matplotlib default style will be used.
title (str | None) – Title of the figure. Defaults to “Coherent Artifact”.

Returns:

Figure object which contains the plots and the Axes.

Return type:

tuple[Figure, Axes]