plesty.lib.monitor.common.series
One field against another, over the rows a run has committed.
Nothing here is about spectra: this is the view of any sweep whose steps each produce a number — a power against an angle, a temperature against time, a count rate against a wavelength.
Classes
One field against another, a point per committed row. |
Module Contents
- class plesty.lib.monitor.common.series.Series(y: str, x: str = '', *, title: str = '', name: str = '', weight: float | None = None, area: str = '', color: str = 'mint', x_label: str = '', y_label: str = '', marker: bool = True)
Bases:
plesty.lib.monitor.plots.PlotOne field against another, a point per committed row.
The ordinary view of a sweep whose steps each produce a number: a power against an angle, a count rate against a wavelength.
Draw y against x over the rows.
- Parameters:
y (str) – Field holding the value.
x (str) – Field holding the position; empty numbers the rows.
title (str) – What the view is called; defaults to the field names.
name (str) – Layout key.
weight (Optional[float]) – Relative size.
area (str) – Which side of the window it starts on.
color (str) – Palette token.
x_label (str) – Axis label; defaults to the field name.
y_label (str) – Axis label; defaults to the field name.
marker (bool) – Mark each point as well as joining them.
- title = 'Series'
- x = ''
- y
- color = 'mint'
- x_label = 'Step'
- y_label
- marker = True
- draw(data: Any) plesty.lib.monitor.plots.Drawing
Draw the series, leaving out rows that carry no value.
- Parameters:
data (Any) – The run’s data.
- Returns:
One curve, or nothing before the first value.
- Return type: