pyCGM2.Report.plot.descriptivePlot

pyCGM2.Report.plot.descriptivePlot(figAxis: Axes, analysisStructureItem: AnalysisStructure, pointLabel: str, contextPointLabel: str, axis: int, color: str | None = None, title: str | None = None, xlabel: str | None = None, ylabel: str | None = None, ylim: List | None = None, legendLabel: str | None = None, customLimits: List | None = None, nan_to_num: bool = True)

Plots descriptive (average and sd corridor) time-normalized traces from an analysis instance.

Parameters:

• figAxis (plt.Axes) – A matplotlib figure axis.

• analysisStructureItem (AnalysisStructure) – An attribute of an analysis instance.

• pointLabel (str) – Point label.

• contextPointLabel (str) – Event context.

• axis (int) – Column index of the point values.

• color (Optional[str], optional) – Line color. Defaults to None.

• title (Optional[str], optional) – Title. Defaults to None.

• xlabel (Optional[str], optional) – X-axis label. Defaults to None.

• ylabel (Optional[str], optional) – Y-axis label. Defaults to None.

• ylim (Optional[List], optional) – Y boundaries. Defaults to None.

• legendLabel (Optional[str], optional) – Legend. Defaults to None.

• customLimits (Optional[List], optional) – Horizontal lines. Defaults to None.

• nan_to_num (bool, optional) – Convert NaN to number. Defaults to True.