piel.visual.experimental.propagation.measurement_data_collection

piel.visual.experimental.propagation.measurement_data_collection#

Attributes#

logger

Functions#

plot_propagation_signals_time(data_collection[, ...])

Generates a series of plots representing the propagation signals over time, where each subplot corresponds

Module Contents#

logger#
plot_propagation_signals_time(data_collection: piel.types.experimental.PropagationDelayMeasurementDataCollection, parameters_list: list = None, measurement_section: list[str] | None = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, figure_title: str = None, create_parameters_tables: bool = True, axes_subtitle_list: list[str] = None, label_per_axes: bool = False, label_style: Literal['label_per_axes', 'label_per_figure'] = 'label_per_figure', dut_plot_kwargs: dict | None = None, reference_plot_kwargs: dict | None = None, figure_kwargs: dict | None = None, legend_kwargs: dict | None = None, rising_edges_kwargs: dict | None = None, *args, **kwargs)[source]#

Generates a series of plots representing the propagation signals over time, where each subplot corresponds to a measurement in the given data collection.

Parameters:#

data_collectionPropagationDelayMeasurementDataCollection

A collection of data related to propagation delay measurements, containing signal waveforms.

parameters_listlist, optional

A list of parameters to be used as labels for the subplots. Defaults to the length of data_collection if None.

measurement_sectionlist[str], optional

List of sections of the measurement for further categorization.

xlabelstr or piel.types.Unit, optional

The label for the x-axis. If a piel.types.Unit object is passed, data correction is applied based on the unit.

ylabelstr or piel.types.Unit, optional

The label for the y-axis. If a piel.types.Unit object is passed, data correction is applied based on the unit.

figure_titlestr, optional

The title of the figure. Defaults to the name of the data collection.

create_parameters_tablesbool, optional

If True, creates tables of parameters for each axis. Defaults to True.

axes_subtitle_listlist[str], optional

A list of subtitles for each axis.

label_per_axesbool, optional

If True, the x and y labels will be set individually for each axis. Defaults to False.

reference_plot_kwargsdict, optional

Customization options for plotting the reference signal (e.g., line style, label). Defaults to a solid line labeled “REF”.

dut_plot_kwargsdict, optional

Customization options for plotting the DUT signal (e.g., line style, label). Defaults to a solid line labeled “DUT”.

figure_kwargsdict, optional

Customization options for figure definition.

*args, **kwargs :

Additional arguments for plot customization, figure saving, or debugging.

Returns:#

: fig : matplotlib.figure.Figure

The figure object containing the plots.

axslist of matplotlib.axes.Axes

List of axes corresponding to the subplots.

Notes:#

  • The function handles missing waveforms gracefully, skipping any missing data.

  • If units are passed for xlabel or ylabel, a correction factor is applied to adjust the plotted data.

  • Parameter tables can be created for each subplot based on the parameters_list.

Contents