plot_overview

plot_overview(result: DatasetConvertible | Result, center_λ: float | None = None, linlog: bool = True, linthresh: float = 1, linscale: float = 1, show_data: bool | None = False, main_irf_nr: int = 0, figsize: tuple[float, float] = (18, 16), 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'>]), figure_only: bool | None = None, nr_of_data_svd_vectors: int = 4, nr_of_residual_svd_vectors: int = 2, show_data_svd_legend: bool = True, show_residual_svd_legend: bool = True, show_irf_dispersion_center: bool = True, show_zero_line: bool = True, das_cycler: Cycler | None | UnsetType = Unset, svd_cycler: Cycler | None | UnsetType = Unset, use_svd_number: bool = False) → tuple[Figure, Axes][source]

Plot overview of the optimization result.

Parameters:

  • result (DatasetConvertible | Result) – Result from a pyglotaran optimization as dataset, Path or Result object.

  • center_λ (float | None) – Center wavelength (λ in nm)

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

  • linscale (float) – This allows the linear range (-linthresh to linthresh) to be stretched relative to the logarithmic range. Its value is the number of decades to use for each half of the linear range. For example, when linscale == 1.0 (the default), the space used for the positive and negative halves of the linear range will be equal to one decade in the logarithmic range. Defaults to 1.

  • show_data (bool | None) – Whether to show the input data or residual. If set to None the plot is skipped which improves plotting performance for big datasets. Defaults to False.

  • main_irf_nr (int) – Index of the main irf component when using an irf parametrized with multiple peaks. Defaults to 0.

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

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

  • figure_only (bool | None) – Deprecated please remove this argument for you function calls. Defaults to None.

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

  • nr_of_residual_svd_vectors (int) – Number of residual SVD vector to plot. Defaults to 2.

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

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

  • show_irf_dispersion_center (bool) – Whether to show the the IRF dispersion center as overlay on the residual/data plot. Defaults to True.

  • show_zero_line (bool) – Whether or not to add a horizontal line at zero to the plots of the spectra. Defaults to True.

  • das_cycler (Cycler | None | UnsetType) – Plot style cycler to use for DAS plots. Defaults to Unset which means that the value of cycler is used.

  • svd_cycler (Cycler | None | UnsetType) – Plot style cycler to use for SVD plots. Defaults to Unset which means that the value of cycler is used.

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

Return type:

tuple[Figure, Axes]