pyCGM2.Lib.plot.plot_DescriptiveKinematic

pyCGM2.Lib.plot.plot_DescriptiveKinematic(DATA_PATH: str, analysis: Analysis, bodyPart: str, normativeDataset: NormativeData, pointLabelSuffix: str | None = None, eventType: str = 'Gait', OUT_PATH: str | None = None, exportPdf: bool = False, outputName: str | None = None, show: bool = True, title: str | None = None, exportPng: bool = False, autoYlim: bool = False)

Displays average and standard deviation of time-normalized kinematic outputs.

Parameters:

• DATA_PATH (str) – Path to the data directory.

• analysis (Analysis) – An Analysis instance containing kinematic data.

• bodyPart (str) – Body part to analyze (choices: ‘LowerLimb’, ‘Trunk’, ‘UpperLimb’).

• normativeDataset (NormativeData) – A NormativeData instance for comparison.

• pointLabelSuffix (Optional[str]) – Suffix previously added to model outputs. Defaults to None.

• eventType (str) – Event type to consider (e.g., ‘Gait’). Defaults to ‘Gait’.

• OUT_PATH (Optional[str]) – Path for saving exported files. Defaults to None.

• exportPdf (bool) – If True, exports the plot as a PDF. Defaults to False.

• outputName (Optional[str]) – Name of the output file. Defaults to None.

• show (bool) – If True, shows the plot using Matplotlib. Defaults to True.

• title (Optional[str]) – Title for the plot panel. Defaults to None.

• exportPng (bool) – If True, exports the plot as a PNG. Defaults to False.

• autoYlim (bool) – If True, sets Y-axis limits automatically. Defaults to False.

Returns:

• Union[matplotlib.figure.Figure, Tuple[matplotlib.figure.Figure, str]] – The Matplotlib figure object.

• If exporting as PNG, returns a tuple of the figure object and the filename.

Examples

>>> fig = plot_DescriptiveKinematic("/data/path", analysisInstance, "LowerLimb", normativeDataset)