High-level functions

CGM modules

CGM1

pyCGM2.Lib.CGM.cgm1.calibrate(DATA_PATH, calibrateFilenameLabelled, translators, required_mp, optional_mp, leftFlatFoot, rightFlatFoot, headFlat, markerDiameter, pointSuffix, **kwargs)

Calibration of the CGM1

Parameters:
  • [str] (pointSuffix) – path to your data
  • [str] – c3d file
  • [dict] (optional_mp) – translators to apply
  • [dict] – required anthropometric data
  • [dict] – optional anthropometric data (ex: LThighOffset,…)
  • [bool] (headFlat) – enable of the flat foot option for the left foot
  • [bool] – enable of the flat foot option for the right foot
  • [bool] – enable of the head flat option
  • [double] (markerDiameter) – marker diameter (mm)
  • [str] – suffix to add to model outputs
pyCGM2.Lib.CGM.cgm1.fitting(model, DATA_PATH, reconstructFilenameLabelled, translators, markerDiameter, pointSuffix, mfpa, momentProjection, **kwargs)

Fitting of the CGM1

Parameters:
  • [str] (momentProjection) – pyCGM2 model previously calibrated
  • [str] – path to your data
  • [string list] (reconstructFilenameLabelled) – c3d files
  • [dict] (translators) – translators to apply
  • [str] – manual force plate assignement
  • [double] (markerDiameter) – marker diameter (mm)
  • [str] – suffix to add to model outputs
  • [str] – Coordinate system in which joint moment is expressed

CGM1.1

pyCGM2.Lib.CGM.cgm1_1.calibrate(DATA_PATH, calibrateFilenameLabelled, translators, required_mp, optional_mp, leftFlatFoot, rightFlatFoot, headFlat, markerDiameter, pointSuffix, **kwargs)

Calibration of the CGM1.1

Parameters:
  • [str] (pointSuffix) – path to your data
  • [str] – c3d file
  • [dict] (optional_mp) – translators to apply
  • [dict] – required anthropometric data
  • [dict] – optional anthropometric data (ex: LThighOffset,…)
  • [bool] (headFlat) – enable of the flat foot option for the left foot
  • [bool] – enable of the flat foot option for the right foot
  • [bool] – enable of the head flat option
  • [double] (markerDiameter) – marker diameter (mm)
  • [str] – suffix to add to model outputs
pyCGM2.Lib.CGM.cgm1_1.fitting(model, DATA_PATH, reconstructFilenameLabelled, translators, markerDiameter, pointSuffix, mfpa, momentProjection, **kwargs)

Fitting of the CGM1.1

Parameters:
  • [str] (momentProjection) – pyCGM2 model previously calibrated
  • [str] – path to your data
  • [string list] (reconstructFilenameLabelled) – c3d files
  • [dict] (translators) – translators to apply
  • [str] – manual force plate assignement
  • [double] (markerDiameter) – marker diameter (mm)
  • [str] – suffix to add to model outputs
  • [str] – Coordinate system in which joint moment is expressed

CGM2.1

pyCGM2.Lib.CGM.cgm2_1.calibrate(DATA_PATH, calibrateFilenameLabelled, translators, required_mp, optional_mp, leftFlatFoot, rightFlatFoot, headFlat, markerDiameter, hjcMethod, pointSuffix, **kwargs)

Calibration of the CGM2.1

Parameters:
  • [str] (pointSuffix) – path to your data
  • [str] – c3d file
  • [dict] (optional_mp) – translators to apply
  • [dict] – required anthropometric data
  • [dict] – optional anthropometric data (ex: LThighOffset,…)
  • [bool] (headFlat) – enable of the flat foot option for the left foot
  • [bool] – enable of the flat foot option for the right foot
  • [bool] – enable of the head flat option
  • [double] (markerDiameter) – marker diameter (mm)
  • [str or list of 3 float] (hjcMethod) – method for locating the hip joint centre
  • [str] – suffix to add to model outputs
pyCGM2.Lib.CGM.cgm2_1.fitting(model, DATA_PATH, reconstructFilenameLabelled, translators, markerDiameter, pointSuffix, mfpa, momentProjection, **kwargs)

Fitting of the CGM2.1

Parameters:
  • [str] (momentProjection) – pyCGM2 model previously calibrated
  • [str] – path to your data
  • [string list] (reconstructFilenameLabelled) – c3d files
  • [dict] (translators) – translators to apply
  • [str] – manual force plate assignement
  • [double] (markerDiameter) – marker diameter (mm)
  • [str] – suffix to add to model outputs
  • [str] – Coordinate system in which joint moment is expressed

CGM2.2

pyCGM2.Lib.CGM.cgm2_2.calibrate(DATA_PATH, calibrateFilenameLabelled, translators, settings, required_mp, optional_mp, ik_flag, leftFlatFoot, rightFlatFoot, headFlat, markerDiameter, hjcMethod, pointSuffix, **kwargs)

Calibration of the CGM2.2

Parameters:
  • [str] (pointSuffix) – path to your data
  • [str] – c3d file
  • [dict] (optional_mp) – translators to apply
  • [dict] – required anthropometric data
  • [dict] – optional anthropometric data (ex: LThighOffset,…)
  • [bool] (headFlat) – enable the inverse kinematic solver
  • [bool] – enable of the flat foot option for the left foot
  • [bool] – enable of the flat foot option for the right foot
  • [bool] – enable of the head flat option
  • [double] (markerDiameter) – marker diameter (mm)
  • [str or list of 3 float] (hjcMethod) – method for locating the hip joint centre
  • [str] – suffix to add to model outputs
pyCGM2.Lib.CGM.cgm2_2.fitting(model, DATA_PATH, reconstructFilenameLabelled, translators, settings, markerDiameter, pointSuffix, mfpa, momentProjection, **kwargs)

Fitting of the CGM2.2

Parameters:
  • [str] (momentProjection) – pyCGM2 model previously calibrated
  • [str] – path to your data
  • [string list] (reconstructFilenameLabelled) – c3d files
  • [dict] (translators) – translators to apply
  • [str] – manual force plate assignement
  • [double] (markerDiameter) – marker diameter (mm)
  • [str] – suffix to add to model outputs
  • [str] – Coordinate system in which joint moment is expressed

CGM2.3

pyCGM2.Lib.CGM.cgm2_3.calibrate(DATA_PATH, calibrateFilenameLabelled, translators, settings, required_mp, optional_mp, ik_flag, leftFlatFoot, rightFlatFoot, headFlat, markerDiameter, hjcMethod, pointSuffix, **kwargs)

Calibration of the CGM2.3

Parameters:
  • [str] (pointSuffix) – path to your data
  • [str] – c3d file
  • [dict] (optional_mp) – translators to apply
  • [dict] – required anthropometric data
  • [dict] – optional anthropometric data (ex: LThighOffset,…)
  • [bool] (headFlat) – enable the inverse kinematic solver
  • [bool] – enable of the flat foot option for the left foot
  • [bool] – enable of the flat foot option for the right foot
  • [bool] – enable of the head flat option
  • [double] (markerDiameter) – marker diameter (mm)
  • [str or list of 3 float] (hjcMethod) – method for locating the hip joint centre
  • [str] – suffix to add to model outputs
pyCGM2.Lib.CGM.cgm2_3.fitting(model, DATA_PATH, reconstructFilenameLabelled, translators, settings, ik_flag, markerDiameter, pointSuffix, mfpa, momentProjection, **kwargs)

Fitting of the CGM2.3

Parameters:
  • [str] (momentProjection) – pyCGM2 model previously calibrated
  • [str] – path to your data
  • [string list] (reconstructFilenameLabelled) – c3d files
  • [dict] (translators) – translators to apply
  • [bool] (ik_flag) – enable the inverse kinematic solver
  • [str] – manual force plate assignement
  • [double] (markerDiameter) – marker diameter (mm)
  • [str] – suffix to add to model outputs
  • [str] – Coordinate system in which joint moment is expressed

CGM2.4

pyCGM2.Lib.CGM.cgm2_4.calibrate(DATA_PATH, calibrateFilenameLabelled, translators, settings, required_mp, optional_mp, ik_flag, leftFlatFoot, rightFlatFoot, headFlat, markerDiameter, hjcMethod, pointSuffix, **kwargs)

Calibration of the CGM2.4

Parameters:
  • [str] (pointSuffix) – path to your data
  • [str] – c3d file
  • [dict] (optional_mp) – translators to apply
  • [dict] – required anthropometric data
  • [dict] – optional anthropometric data (ex: LThighOffset,…)
  • [bool] (headFlat) – enable the inverse kinematic solver
  • [bool] – enable of the flat foot option for the left foot
  • [bool] – enable of the flat foot option for the right foot
  • [bool] – enable of the head flat option
  • [double] (markerDiameter) – marker diameter (mm)
  • [str or list of 3 float] (hjcMethod) – method for locating the hip joint centre
  • [str] – suffix to add to model outputs
pyCGM2.Lib.CGM.cgm2_4.fitting(model, DATA_PATH, reconstructFilenameLabelled, translators, settings, ik_flag, markerDiameter, pointSuffix, mfpa, momentProjection, **kwargs)

Fitting of the CGM2.4

Parameters:
  • [str] (momentProjection) – pyCGM2 model previously calibrated
  • [str] – path to your data
  • [string list] (reconstructFilenameLabelled) – c3d files
  • [dict] (translators) – translators to apply
  • [bool] (ik_flag) – enable the inverse kinematic solver
  • [str] – manual force plate assignement
  • [double] (markerDiameter) – marker diameter (mm)
  • [str] – suffix to add to model outputs
  • [str] – Coordinate system in which joint moment is expressed

Analysis module

pyCGM2.Lib.analysis.automaticCPdeviations(DATA_PATH, analysis, pointLabelSuffix=None, filterTrue=False, export=True, outputname='Nieuwenhuys2017')

Detect gait deviation for CP according a Delphi Consensus (Nieuwenhuys2017 et al 2017)

Parameters:[pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
pyCGM2.Lib.analysis.exportAnalysis(analysisInstance, DATA_PATH, name, mode='Advanced')

exportAnalysis : export the pyCGM2.Processing.analysis.Analysis instance in a xls spreadsheet

Parameters:
  • [pyCGM2.Processing.analysis.Analysis] (analysisInstance) – pyCGM2 analysis instance
  • [str] (DATA_PATH) – path to your data
  • [string] (name) – name of the output file

optional

Parameters:[string] (mode) – structure of the output xls (choice: Advanced[Default] or Basic)

Note

the advanced xls organizes data by row ( one raw = on cycle) whereas the Basic mode exports each model output in a new sheet

pyCGM2.Lib.analysis.makeAnalysis(DATA_PATH, modelledFilenames, type='Gait', subjectInfo=None, experimentalInfo=None, modelInfo=None, pointLabelSuffix=None, kinematicLabelsDict=None, kineticLabelsDict=None, disableKinetics=False, openmaTrials=None)

makeAnalysis : create the pyCGM2.Processing.analysis.Analysis instance

Parameters:
  • [str] (DATA_PATH) – path to your data
  • [string list] (modelledFilenames) – c3d files with model outputs

optional

Parameters:
  • [str] (type) – process files with gait events if selected type is Gait
  • [dict] (kineticLabelsDict) – dictionnary gathering info about the patient (name,dob…)
  • [dict] – dictionnary gathering info about the data session (orthosis, gait task,… )
  • [dict] – dictionnary gathering info about the used model)
  • [string] (pointLabelSuffix) – suffix previously added to your model outputs
  • [dict] – dictionnary with two entries,Left and Right, pointing to kinematic model outputs you desire processes
  • [dict] – dictionnary with two entries,Left and Right, pointing to kinetic model outputs you desire processes
  • [bool] (openmaTrials) – disable kinetics processing
  • [bool] – force the use of a list of openma trials

Note

The dictionnaries (subjectInfo,experimentalInfo,modelInfo) is interesting if you want to find these information within the xls file

pyCGM2.Lib.analysis.makeEmgAnalysis(DATA_PATH, processedEmgFiles, emgChannels, subjectInfo=None, experimentalInfo=None, type='Gait', openmaTrials=None)

makeEmgAnalysis : create the pyCGM2.Processing.analysis.Analysis instance with only EMG signals

Parameters:
  • [str] (DATA_PATH) – path to your data
  • [string list] (emgChannels) – c3d files with emg processed outputs
  • [string list] – label of your emg channels

optional

Parameters:
  • [dict] (experimentalInfo) – dictionnary gathering info about the patient (name,dob…)
  • [dict] – dictionnary gathering info about the data session (orthosis, gait task,… )
  • [str] (type) – process files with gait events if selected type is Gait
  • [bool] (openmaTrials) – force the use of a list of openma trials
pyCGM2.Lib.analysis.normalizedEMG(analysis, emgChannels, contexts, method='MeanMax', fromOtherAnalysis=None)

normalizedEMG : perform normalization of emg in amplitude

Parameters:
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
  • [string list] (contexts) – label of your emg channels
  • [string list] – contexts associated with your emg channel

optional

Parameters:
  • [str] (method) – method of amplitude normalisation (choice MeanMax[default], MaxMax, MedianMax)
  • [pyCGM2.Processing.analysis.Analysis] (fromOtherAnalysis) – amplitude normalisation from another analysis instance
pyCGM2.Lib.analysis.processEMG(DATA_PATH, gaitTrials, emgChannels, highPassFrequencies=[20, 200], envelopFrequency=6.0, fileSuffix=None)

processEMG_fromC3dFiles : filters emg channels from a list of c3d files

Parameters:[String] (DATA_PATH) – path to your folder

:param gaitTrials [string List]:c3d files with emg signals :param emgChannels [string list]: label of your emg channels

optional

Parameters:
  • [list of float] (highPassFrequencies) – boundaries of the bandpass filter
  • [float] (envelopFrequency) – cut-off frequency for creating an emg envelop
  • [string] (fileSuffix) – suffix added to your ouput c3d files
pyCGM2.Lib.analysis.processEMG_fromBtkAcq(acq, emgChannels, highPassFrequencies=[20, 200], envelopFrequency=6.0)

processEMG_fromBtkAcq : filt emg from a btk acq

Parameters:
  • [btk::Acquisition] (acq) – btk acquisition
  • [string list] (emgChannels) – label of your emg channels

optional

Parameters:
  • [list of float] (highPassFrequencies) – boundaries of the bandpass filter
  • [float] (envelopFrequency) – cut-off frequency for creating an emg envelop

Plot module

pyCGM2.Lib.plot.compareEmgEvelops(analyses, legends, emgChannels, muscles, contexts, normalActivityEmgs, normalized=False, plotType='Descriptive', show=True, title=None)

compareEmgEvelops : compare emg envelops from two pyCGM2 analysis instances

Parameters:
  • [pyCGM2.Processing.analysis.Analysis list] (analysis) – list of pyCGM2 analysis instances
  • [string list] (normalActivityEmgs) – legend of each analysis instance
  • [string list] – label of your emg channels
  • [string list] – muscle label associated with your emg channels
  • [string list] – context associated with your emg channels
  • [string list] – normal activity associated with your emg channels

optional :param normalized [bool]: plot normalized-amplitude envelops :param plotType [string]: trace type ( Descriptive [default] or Consistency) :param show [bool]: enable matplotlib show function :param title [string]: change default title of the plot panel

Example:

>> plot.compareEmgEvelops([emgAnalysisPre,emgAnalysisPost], >>> [“Pre”,”Post”], >>> [“EMG1”,”EMG2”] >>> [“Left”,”Right”] >>> [“RECFEM”,”VASLAT”])

pyCGM2.Lib.plot.compareKinematic(analyses, legends, context, bodyPart, normativeDataset, plotType='Descriptive', type='Gait', pointSuffixes=None, show=True, title=None)

compareKinematic : compare kinematics of two pyCGM2 analysis instances

Parameters:
  • [pyCGM2.Processing.analysis.Analysis list] (analysis) – list of pyCGM2 analysis instances
  • [string list] (legends) – legend of each analysis instance
  • [string] (context) – gait context ( choice: Left, Right)
  • [str] (bodyPart) – body part (choice : LowerLimb, Trunk, UpperLimb)
  • [pyCGM2.Report.normativeDatasets] (normativeDataset) – pyCGM2 normative dataset instance

optional

Parameters:
  • [string] (type) – trace type ( Descriptive [default] or Consistency)
  • [string] – display events (Gait [defaut] or None)
Example: 
>>> normativeData = normativeDatasets.Schwartz2008("Free")
>>> plot.compareKinematic([analysisPre,analysisPost],["pre","post"],"Left","LowerLimb",normativeData)
pyCGM2.Lib.plot.compareKinetic(analyses, legends, context, bodyPart, normativeDataset, plotType='Descriptive', type='Gait', pointSuffixes=None, show=True, title=None)

compareKinetic : compare kinetics of two pyCGM2 analysis instances

Parameters:
  • [pyCGM2.Processing.analysis.Analysis list] (analysis) – list of pyCGM2 analysis instances
  • [string list] (legends) – legend of each analysis instance
  • [string] (context) – gait context (choice: Left, Right)
  • [str] (bodyPart) – body part (choice : LowerLimb, Trunk, UpperLimb)
  • [pyCGM2.Report.normativeDatasets] (normativeDataset) – pyCGM2 normative dataset instance

optional

Parameters:
  • [string] (title) – trace type ( Descriptive [default] or Consistency)
  • [string] – display events (Gait [defaut] or None)
  • [bool] (show) – enable matplotlib show function
  • [string] – change default title of the plot panel
Example: 
>>> normativeData = normativeDatasets.Schwartz2008("Free")
>>> plot.compareKinetic([analysisPre,analysisPost],["pre","post"],"Left","LowerLimb",normativeData)
pyCGM2.Lib.plot.compareSelectedEmgEvelops(analyses, legends, emgChannels, contexts, normalized=False, plotType='Descriptive', type='Gait', show=True, title=None)

compareSelectedEmgEvelops : compare selected emg envelops from pyCGM2 analysis instances

Parameters:
  • [pyCGM2.Processing.analysis.Analysis list] (analysis) – list of pyCGM2 analysis instances
  • [string list] (contexts) – legend of each analysis instance
  • [string list] – label of your emg channels
  • [string list] – context associated with your emg channels

optional :param normalized [bool]: display normalized amplitude envelop (false [defaut]) :param plotType [string]: trace type ( Descriptive [default] or Consistency) :param type [string]: display events (Gait [defaut] or None) :param show [bool]: enable matplotlib show function :param title [string]: change default title of the plot panel :example:

>>> plot.compareSelectedEmgEvelops([emgAnalysisPre,emgAnalysisPost],["Pre","Post"],["EMG1","EMG1"],["Left","Left"],normalized=False)
pyCGM2.Lib.plot.plotConsistencyEnvelopEMGpanel(DATA_PATH, analysis, emgChannels, muscles, contexts, normalActivityEmgs, normalized=False, type='Gait', exportPdf=False, outputName=None, show=True, title=None)

plotConsistencyEnvelopEMGpanel : display all cycle of time-normalized traces of EMG envelops

Parameters:
  • [str] (DATA_PATH) – path to your data
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
  • [string list] (normalActivityEmgs) – labels of your emg channels
  • [string list] – muscle labels associated with your emg channels
  • [string list] – contexts associated with your emg channels
  • [string list] – normal activities associated with your emg channels

optional

Parameters:
  • [bool] (show) – (default: False) plot normalized amplitude envelops
  • [string] (title) – display gait events ( other choice than gait [default], display foot strikes only)
  • [bool] – save as pdf (False[default])
  • [string] – name of your pdf file (None[default] export your pdf with name : Global Analysis)
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
pyCGM2.Lib.plot.plotDescriptiveEnvelopEMGpanel(DATA_PATH, analysis, emgChannels, muscles, contexts, normalActivityEmgs, normalized=False, type='Gait', exportPdf=False, outputName=None, show=True, title=None)

plotDescriptiveEnvelopEMGpanel : display average and standard deviation of time-normalized traces of EMG envelops

Parameters:
  • [str] (DATA_PATH) – path to your data
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
  • [string list] (normalActivityEmgs) – labels of your emg channels
  • [string list] – muscle labels associated with your emg channels
  • [string list] – contexts associated with your emg channels
  • [string list] – normal emg activities associated with your emg channels

optional

Parameters:
  • [bool] (show) – plot normalized amplitude envelops (False[default])
  • [string] (title) – display gait events (other choice than gait [default], display foot strikes only)
  • [bool] – save as pdf (False[default])
  • [string] – name of your pdf file (None[default] export your pdf with name : Global Analysis)
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
pyCGM2.Lib.plot.plotTemporalEMG(DATA_PATH, processedEmgfile, emgChannels, muscles, contexts, normalActivityEmgs, rectify=True, exportPdf=False, outputName=None, show=True, title=None, openmaTrial=None)

plotTemporalEMG : display temporal trace of EMG signals

Parameters:
  • [str] (DATA_PATH) – path to your data
  • [string] (processedEmgfile) – c3d file
  • [string list] (normalActivityEmgs) – labels of your emg channels
  • [string list] – muscle labels associated with your emg channels
  • [string list] – contexts associated with your emg channel
  • [string list] – normal activities associated with your emg channels
  • [openma::Trial] (openmaTrial) – force use of an openma trial instance

optional

Parameters:
  • [bool] (show) – plot rectify signals (True[default])
  • [bool] – save as pdf (False[default])
  • [string] (title) – name of the output filed
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
pyCGM2.Lib.plot.plotTemporalKinematic(DATA_PATH, modelledFilenames, bodyPart, pointLabelSuffix=None, exportPdf=False, outputName=None, show=True, title=None, openmaTrial=None)

plotTemporalKinematic : display temporal trace of the Kinematics

Parameters:
  • [str] (bodyPart) – path to your data
  • [string list] (modelledFilenames) – c3d files
  • [str] – body part (choice : LowerLimb, Trunk, UpperLimb)

optional

Parameters:
  • [string] (title) – suffix previously added to your model outputs
  • [bool] (show) – save as pdf (False[default])
  • [string] – name of the output filed
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
  • [openma::Trial] (openmaTrial) – force use of an openma trial instance

Examples:

pyCGM2.Lib.plot.plotTemporalKinetic(DATA_PATH, modelledFilenames, bodyPart, pointLabelSuffix=None, exportPdf=False, outputName=None, show=True, title=None, openmaTrial=None)

plotTemporalKinetic : display temporal trace of the Kinetics

Parameters:
  • [str] (bodyPart) – path to your data
  • [string list] (modelledFilenames) – c3d files
  • [str] – body part (choice : LowerLimb, Trunk, UpperLimb)

optional

Parameters:
  • [string] (title) – suffix previously added to your model outputs
  • [bool] (show) – save as pdf (False[default])
  • [string] – name of the output filed
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
  • [openma::Trial] (openmaTrial) – force use of an openma trial instance

Examples:

pyCGM2.Lib.plot.plot_ConsistencyKinematic(DATA_PATH, analysis, bodyPart, normativeDataset, pointLabelSuffix=None, type='Gait', exportPdf=False, outputName=None, show=True, title=None)

plot_ConsistencyKinematic : display all gait cycle of time-normalized kinematic outputs

Parameters:
  • [str] (bodyPart) – path to your data
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
  • [str] – body part (choice : LowerLimb, Trunk, UpperLimb)
  • [pyCGM2.Report.normativeDatasets] (normativeDataset) – pyCGM2 normative dataset instance

optional

Parameters:
  • [string] (title) – suffix previously added to your model outputs
  • [string] – display gait events ( other choice than gait [default], display foot strikes only)
  • [bool] (show) – save as pdf (False[default])
  • [string] – name of your pdf file (None[default] export your pdf with name : Global Analysis)
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
pyCGM2.Lib.plot.plot_ConsistencyKinetic(DATA_PATH, analysis, bodyPart, normativeDataset, pointLabelSuffix=None, type='Gait', exportPdf=False, outputName=None, show=True, title=None)

plot_ConsistencyKinetic : display all gait cycle of time-normalized kinetic outputs

Parameters:
  • [str] (bodyPart) – path to your data
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
  • [str] – body part (choice : LowerLimb, Trunk, UpperLimb)
  • [pyCGM2.Report.normativeDatasets] (normativeDataset) – pyCGM2 normative dataset instance

optional

Parameters:
  • [string] (title) – suffix previously added to your model outputs
  • [string] – display gait events ( other choice than gait [default], display foot strikes only)
  • [bool] (show) – save as pdf (False[default])
  • [string] – name of your pdf file (None[default] export your pdf with name : Global Analysis)
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
pyCGM2.Lib.plot.plot_DescriptiveKinematic(DATA_PATH, analysis, bodyPart, normativeDataset, pointLabelSuffix=None, type='Gait', exportPdf=False, outputName=None, show=True, title=None)

plot_DescriptiveKinematic : display average and standard deviation of time-normalized kinematic outputs

Parameters:
  • [str] (bodyPart) – path to your data
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
  • [str] – body part (choice : LowerLimb, Trunk, UpperLimb)
  • [pyCGM2.Report.normativeDatasets] (normativeDataset) – pyCGM2 normative dataset instance

optional

Parameters:
  • [string] (title) – suffix previously added to your model outputs
  • [string] – display gait events ( other choice than gait [default], display foot strikes only)
  • [bool] (show) – save as pdf (False[default])
  • [string] – name of your pdf file (None[default] export your pdf with name : Global Analysis)
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
pyCGM2.Lib.plot.plot_DescriptiveKinetic(DATA_PATH, analysis, bodyPart, normativeDataset, pointLabelSuffix=None, type='Gait', exportPdf=False, outputName=None, show=True, title=None)

plot_DescriptiveKinetic : display average and standard deviation of time-normalized kinetic outputs

Parameters:
  • [str] (bodyPart) – path to your data
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
  • [str] – body part (choice : LowerLimb, Trunk, UpperLimb)
  • [pyCGM2.Report.normativeDatasets] (normativeDataset) – pyCGM2 normative dataset instance

optional

Parameters:
  • [string] (title) – suffix previously added to your model outputs
  • [string] – display gait events ( other choice than gait [default], display foot strikes only)
  • [bool] (show) – save as pdf (False[default])
  • [string] – name of your pdf file (None[default] export your pdf with name : Global Analysis)
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
pyCGM2.Lib.plot.plot_MAP(DATA_PATH, analysis, normativeDataset, exportPdf=False, outputName=None, pointLabelSuffix=None, show=True, title=None)

plot_MAP : display the Movement Analysis Profile

Parameters:
  • [str] (DATA_PATH) – path to your data
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance
  • [pyCGM2.Report.normativeDatasets] (normativeDataset) – pyCGM2 normative dataset instance

optional

Parameters:
  • [string] (title) – (None) suffix added to outputs
  • [bool] (show) – save as pdf (False[default])
  • [string] – name of your pdf file (None[default] export your pdf with name : Global Analysis)
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel
pyCGM2.Lib.plot.plot_spatioTemporal(DATA_PATH, analysis, exportPdf=False, outputName=None, show=True, title=None)

plot_spatioTemporal : display spatio-temporal parameters as horizontal histogram

Parameters:
  • [str] (DATA_PATH) – path to your data
  • [pyCGM2.Processing.analysis.Analysis] (analysis) – pyCGM2 analysis instance

optional

Parameters:
  • [bool] (show) – save as pdf (False[default])
  • [string] (title) – name of your pdf file (None[default] export your pdf with name : Global Analysis)
  • [bool] – enable matplotlib show function
  • [string] – change default title of the plot panel