Hardware Loop Plot¶

class HardwareLoopPlot(title=None, canvas=None, axes=None)[source]¶

Base class for all plots visualized during hardware loop runtime.

Parameters:

title (str | None) – Title of the hardware loop plot. If not specified, resorts to the default title of the plot.
canvas (FigureCanvasBase | None) – Canvas to plot into. If not specified, a new canvas is created.
axes (ndarray[tuple[int, int], dtype[Any]] | None) – Visualization axes to plot into. If not specified, a new figure is created.

abstract _initial_plot(sample, axes)[source]¶

Initial plot of the hardware loop plot.

Parameters:

sample (HardwareLoopSample) – Hardware loop sample to be plotted.
axes (ndarray[tuple[int, int], dtype[Any]]) – The visualization to be plotted into.

Return type:

TypeVar(VT, bound= Visualization)

Returns: The plotted information including axes and lines.

abstract _prepare_plot()[source]¶

Prepare the figure for the hardware loop plot.

Returns: The prepared figure and axes to be plotted into.

Return type:: Tuple[Figure, ndarray[tuple[int, int], dtype[Any]]]

abstract _update_plot(sample, visualization)[source]¶

Update the hardware loop plot.

Parameters:

sample (HardwareLoopSample) – Hardware loop sample to be plotted.
visualization (TypeVar(VT, bound= Visualization)) – The visualization to be updated.

Return type:

None

close_plot()[source]¶

Close the hardware loop plot.

prepare_plot()[source]¶

Prepare the figure for the hardware loop plot.

Returns: The prepared figure canvas, axes and fiugure to be plotted into.

Return type:: Tuple[FigureCanvasBase, ndarray[tuple[int, int], dtype[Any]], FigureBase]

update_plot(sample)[source]¶

Update the hardware loop plot.

Internally calls the abstract _update_plot() method.

Parameters:: sample (HardwareLoopSample) – Hardware loop sample to be plotted.
Return type:: None

abstract property _default_title: str[source]¶: Default title of the hardware loop plot.

property hardware_loop: HardwareLoop | None[source]¶: Hardware loop this plot is attached to.