CADETProcess.reference.ReferenceIO.plot_purity

ReferenceIO.plot_purity(start: float | None = None, end: float | None = None, components: list[str] | None = None, layout: Layout | None = None, y_max: float | None = None, x_axis_in_minutes: bool = True, plot_components_purity: bool = True, plot_species_purity: bool = False, alpha: float = 1, hide_labels: bool = False, show_legend: bool = True, ax: Axes | None = None) → Axes

Plot local purity for each component of the concentration profile.

Parameters:

startfloat, optional

Start time for plotting in seconds. If None is provided, the first data point will be used as the start time. The default is None.

endfloat, optional

End time for plotting in seconds. If None is provided, the last data point will be used as the end time. The default is None.

componentslist, optional.

List of components to be plotted. If None, all components are plotted. Note that if components are excluded, they will also not be considered in the calculation of the purity.

layoutplotting.Layout

Plot layout options.

y_maxfloat, optional

Maximum value of y axis. If None, value is automatically deferred from solution.

x_axis_in_minutesbool, optional

If True, the x-axis will be plotted using minutes. The default is True.

plot_components_puritybool, optional

If True, plot purity of total component concentration. The default is True.

plot_species_puritybool, optional

If True, plot purity of individual species. The default is False.

alphafloat, optional

Opacity of line.

hide_labelsbool, optional

If True, hide labels. The default is False.

show_legendbool, optional

If True, show legend. The default is True.

axAxes

Axes to plot on.

Returns:

axAxes

Axes with plot of purity over time.

Raises:

CADETProcessError

If solution has less than 2 components.

See also

slice_solution

plotlib

plot