pyCGM2.Lib.plot.plotSaggitalGagePanel

pyCGM2.Lib.plot.plotSaggitalGagePanel(DATA_PATH: str, analysis: Analysis, normativeDataset: NormativeData, emgType: str = 'Envelope', exportPdf: bool = False, OUT_PATH: str | None = None, outputName=None, show: bool = True, title=None, exportPng=False, autoYlim: bool = False, **kwargs)

Creates and displays a saggital gait analysis plot as described in ‘The Identification and Treatment of Gait Problems in Cerebral Palsy’ by Gage et al.

This function generates a plot that combines kinematic, kinetic, and electromyographic data to provide a comprehensive view of sagittal gait analysis.

Parameters:

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

• analysis (Analysis) – An Analysis instance containing the gait analysis data.

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

• emgType (str) – type of emg signal to plot. Defaults to Envelope, choice: Raw or Rectify.

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

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

• outputName (Optional[str]) – Name of the output file. Defaults to ‘PyCGM2-Analysis’.

• 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.

• **kwargs – Additional keyword arguments, including ‘forceEmgManager’ for specifying an EMG Manager.

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.