plot_guidance

plot_guidance(result: DatasetConvertible | Result, figsize: tuple[float, float] = (15, 5), title: str = 'Guidance Overview', y_label: str = 'a.u.', 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'>])) → tuple[Figure, Axes][source]

Plot overview for a guidance spectrum.

Parameters:

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

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

  • title (str) – Title to add to the figure. Defaults to “Guidance Overview”

  • y_label (str) – Label used for the y-axis of each subplot. Defaults to “a.u.”

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

Returns:

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

Return type:

tuple[Figure, Axes]