piel.visual.plot.metrics.scalar_metric_collection

piel.visual.plot.metrics.scalar_metric_collection#

Attributes#

logger

Functions#

plot_basic_scalar_metric_collection_component(...[, ...])

Plots the specified component (e.g., 'mean', 'min', 'max') of a ScalarMetricCollection.

Module Contents#

logger#
plot_basic_scalar_metric_collection_component(scalar_metric_collection, metric_component: str, fig: Any = None, axs: Any = None, subplots_kwargs: dict = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, title: str | piel.types.Unit = None, label: str | piel.types.Unit = '', **kwargs)[source]#

Plots the specified component (e.g., ‘mean’, ‘min’, ‘max’) of a ScalarMetricCollection.

Parameters:

  • scalar_metric_collection (ScalarMetricCollection) – The collection of scalar metrics to plot.

  • metric_component (str) – The component of the ScalarMetric to plot (e.g., ‘mean’, ‘min’, ‘max’, ‘value’, ‘standard_deviation’, ‘count’).

  • fig (matplotlib.figure.Figure, optional) – Existing figure to plot on. If None, a new figure is created.

  • axs (list[matplotlib.axes.Axes], optional) – Existing list of axes to plot on. If None, new axes are created. Plots on [0] by default.

  • subplots_kwargs (dict, optional) – Keyword arguments to pass to create_axes_per_figure.

  • xlabel (str | Unit, optional) – Label for the x-axis.

  • ylabel (str | Unit, optional) – Label for the y-axis.

  • title (str | Unit, optional) – Title for the plot.

  • **kwargs – Additional keyword arguments to pass to the save function.

Returns:

A tuple containing the figure and axes objects.

Return type:

tuple

Contents