CADETProcess.solution.SolutionIO.plot_purity#
- SolutionIO.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 | None = True, plot_components_purity: bool | None = True, plot_species_purity: bool | None = False, alpha: float | None = 1, hide_labels: bool | None = False, show_legend: bool | None = True, ax: Axes | None = None) Axes[source]#
Plot local purity for each component of the concentration profile.
- Parameters:
- startOptional[float]
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.
- endOptional[float]
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.
- componentsOptional[list[str]]
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.
- layoutOptional[plotting.Layout]
Plot layout options.
- y_maxOptional[float]
Maximum value of y axis. If None, value is automatically deferred from solution.
- x_axis_in_minutesOptional[bool], default=True
If True, the x-axis will be plotted using minutes.
- plot_components_purityOptional[bool], default=True
If True, plot purity of total component concentration.
- plot_species_purityOptional[bool], default=False
If True, plot purity of individual species.
- alphaOptional[float], default=1
Opacity of line.
- hide_labelsOptional[bool], default=False
If True, hide labels.
- show_legendOptional[bool], default=True
If True, show legend.
- axOptional[Axes]
Axes to plot on.
- Returns:
- Axes
Axes with plot of purity over time.
- Raises:
- CADETProcessError
If solution has less than 2 components.
See also
slice_solutionplotlibplot