SessionPlotBase

class SessionPlotBase[source]

Bases: object

Base class for generating session summary plots.

__init__() → None[source]

Initializes the SessionPlotBase instance.

Methods

__init__()

Initializes the SessionPlotBase instance.

create_plot(df[, weight, width, height])

Creates a session summary plot.
create_plot(df: pandas.DataFrame, weight: float = 0.0, width: float = 10, height: float = 8) → matplotlib.figure.Figure[source]

Creates a session summary plot.

Default behavior is to plot the cumulative count of trials by trial start time. This method is intended to be overridden by subclasses for custom plots.

Parameters:

  • df (pd.DataFrame) – The session data.

  • weight (float, optional) – The weight of the subject. Defaults to 0.0.

  • width (float, optional) – Width of the figure. Defaults to 10.

  • height (float, optional) – Height of the figure. Defaults to 8.

Returns:

The generated matplotlib figure.

Return type:

Figure