GroundReactionForceComparisonViewer

class pyCGM2.Report.Viewers.comparisonPlotViewers.GroundReactionForceComparisonViewer(iAnalyses: List[Analysis], legends: List[str], pointLabelSuffix_lst: List[str] | None = None)

A viewer for comparing Ground reaction Force across multiple Analysis instances.

This class is designed for the visualization and comparison of ground reaction force from different analysis instances.

Parameters:

• iAnalyses (List[Analysis]) – Instances of analyses to be compared.

• legends (List[str]) – Descriptive labels for each analysis instance.

• pointLabelSuffix_lst (Optional[List[str]]) – Suffixes for model output labels.

• bodyPart (enums.BodyPartPlot) – The body part to be visualized, defaults to LowerLimb.

__init__(iAnalyses: List[Analysis], legends: List[str], pointLabelSuffix_lst: List[str] | None = None)

Initialize the comparison plot viewer

Methods

__init__(iAnalyses, legends[, ...])	Initialize the comparison plot viewer
plotPanel()	Generates and plots the kinematic comparison panel.
setAutomaticYlimits(bool)	Sets whether Y-axis limits should be auto-adjusted.
setConcretePlotFunction(concreteplotFunction)	Sets a specific plot function for kinetic data visualization.
setNormativeData()	Abstract method to set a normative dataset.
setNormativeDataset(iNormativeDataSet)	Set the normative dataset for comparison.

plotPanel()

Generates and plots the kinematic comparison panel.

This method orchestrates the plotting process, including setting up the layers, arranging data, and rendering the final plot.

Returns:

matplotlib.figure.Figure – The generated plot as a matplotlib figure object.

Raises:

Exception – If the concrete plot function is not defined.

setConcretePlotFunction(concreteplotFunction: Callable)

Sets a specific plot function for kinetic data visualization.

This method allows the customization of the plot based on the user’s needs, enabling the use of various plot types from the pyCGM2.Report.plot library.

Parameters:

concreteplotFunction (Callable) – A plot function from pyCGM2.Report.plot.

setNormativeDataset(iNormativeDataSet: NormativeData)

Set the normative dataset for comparison.

Parameters:

iNormativeDataSet (NormativeData) – An instance of a normative dataset.