pyCGM2.Lib.analysis.automaticCPdeviations

pyCGM2.Lib.analysis.automaticCPdeviations(DATA_PATH: str, analysis: Analysis, reference: str = 'Nieuwenhuys2017', pointLabelSuffix: str | None = None, filterTrue: bool = False, export: bool = True, outputname: str = 'Nieuwenhuys2017', language: str = '-fr')

Calculate and optionally export joint pattern deviations based on a specified reference.

This function processes joint patterns using rules defined in an external Excel file, filters and retrieves pattern data, and can export the results to Excel files.

Parameters:

• DATA_PATH (str) – The path where the export files will be saved.

• analysis (Analysis) – The Analysis object containing the necessary analysis data.

• reference (str, optional) – Reference name for the joint pattern rules. Defaults to “Nieuwenhuys2017”.

• pointLabelSuffix (Optional[str], optional) – Suffix for the point labels. Defaults to None.

• filterTrue (bool, optional) – If True, applies additional filtering to the patterns. Defaults to False.

• export (bool, optional) – If True, exports the resulting data to Excel files. Defaults to True.

• outputname (str, optional) – Base name for the output files. Defaults to “Nieuwenhuys2017”.

• language (str, optional) – Language specifier for the rules file, e.g., ‘-fr’ for French. Defaults to “-fr”.

Returns:

pd.DataFrame – A DataFrame containing the joint pattern deviations.

Note

Requires external Excel files for rules, located in PYCGM2_SETTINGS_FOLDER.

Example

>>> patterns = automaticCPdeviations("/path/to/data", analysisObj)