AnalysisBuilder

class pyCGM2.Processing.analysis.AnalysisBuilder(cycles: Cycles, kinematicLabelsDict: Dict[str, List[str]] | None = None, kineticLabelsDict: Dict[str, List[str]] | None = None, pointlabelSuffix: str | None = None, emgLabelList: List[str] | None = None, geometryMuscleLabelsDict: Dict[str, List[str]] | None = None, dynamicMuscleLabelsDict: Dict[str, List[str]] | None = None, modelInfos: Dict | None = None, subjectInfos: Dict | None = None, experimentalInfos: Dict | None = None, emgs: Any | None = None)

Analysis builder

Unlike GaitAnalysisBuilder, this builder does not compute spatiotemporal parameters

Parameters:

• cycles (Cycles) – Cycles instance built from CycleFilter.

• kinematicLabelsDict (Optional[Dict[str, List[str]]]) – Dictionary grouping kinematic output labels.

• kineticLabelsDict (Optional[Dict[str, List[str]]]) – Dictionary grouping kinetic output labels.

• pointlabelSuffix (Optional[str]) – Suffix for kinematic and kinetic labels.

• emgLabelList (Optional[List[str]]) – List of EMG labels.

• geometryMuscleLabelsDict (Optional[Dict[str, List[str]]]) – Dictionary grouping muscle geometry labels.

• dynamicMuscleLabelsDict (Optional[Dict[str, List[str]]]) – Dictionary grouping muscle dynamic labels.

• modelInfos (Optional[Dict]) – Information about the model.

• subjectInfos (Optional[Dict]) – Information about the subject.

• experimentalInfos (Optional[Dict]) – Information about the experimental conditions.

• emgs (Optional[Any]) – Additional EMG data.

Notes

modelInfos,`experimentalInfos`, subjectInfos are simple dictionaries used to store basic information. When the analysis is exported as speadsheet, these informations appear as columns.

__init__(cycles: Cycles, kinematicLabelsDict: Dict[str, List[str]] | None = None, kineticLabelsDict: Dict[str, List[str]] | None = None, pointlabelSuffix: str | None = None, emgLabelList: List[str] | None = None, geometryMuscleLabelsDict: Dict[str, List[str]] | None = None, dynamicMuscleLabelsDict: Dict[str, List[str]] | None = None, modelInfos: Dict | None = None, subjectInfos: Dict | None = None, experimentalInfos: Dict | None = None, emgs: Any | None = None)

Methods

__init__(cycles[, kinematicLabelsDict, ...])
computeEmgEnvelopes()	Compute descriptive statistics of EMG envelopes.
computeKinematics()	Compute descriptive statistics of kinematic parameters.
computeKinetics()	Compute descriptive statistics of kinetic parameters.
computeMuscleDynamic()	Compute descriptive statistics of muscle dynamic parameters.
computeMuscleGeometry()	Compute descriptive statistics of muscle geometry parameters.
computeSpatioTemporel()

computeEmgEnvelopes()

Compute descriptive statistics of EMG envelopes.

Returns:

Tuple[Dict, Dict] – Tuple containing the output dictionary of EMG data and the associated spatiotemporal parameters.

computeKinematics()

Compute descriptive statistics of kinematic parameters.

Returns:

Tuple[Dict, Dict] – Tuple containing the output dictionary of kinematic data and the associated spatiotemporal parameters.

computeKinetics()

Compute descriptive statistics of kinetic parameters.

Returns:

Tuple[Dict, Dict, Dict] – Tuple containing the output dictionary of kinetic data, the associated spatiotemporal parameters, and optional additional data.

computeMuscleDynamic()

Compute descriptive statistics of muscle dynamic parameters.

Returns:

Tuple[Dict, Dict, Dict] – Tuple containing the output dictionary of muscle dynamic data, the associated spatiotemporal parameters, and optional additional data.

computeMuscleGeometry()

Compute descriptive statistics of muscle geometry parameters.

Returns:

Tuple[Dict, Dict] – Tuple containing the output dictionary of muscle geometry data and the associated spatiotemporal parameters.