pyCGM2.Model

• Components
• BodySegmentParameters
• CGM

Filters

ModelCalibrationFilter(procedure, acq, iMod, ...)	Calibrate a model from a static acquisition.
ModelMotionFilter(procedure, acq, iMod, ...)	Updates the model with the pose of both technical and anatomical coordinate systems at each frame.
ModelJCSFilter(iMod, acq)	Compute the relative joint angles using joint coordinate systems.
ModelAbsoluteAnglesFilter(iMod, acq[, ...])	Compute absolute joint angles.
ForcePlateAssemblyFilter(iMod, btkAcq, ...)	Assemble force plates with the model for dynamic trials.
GroundReactionIntegrationFilter(procedure, ...)	Integrates ground reaction forces into the model during dynamic trials.
GroundReactionForceAdapterFilter(btkAcq[, ...])	Filter to standardize ground reaction force data in a biomechanical model.
InverseDynamicFilter(iMod, btkAcq[, ...])	Compute joint forces and moments from inverse dynamics.
JointPowerFilter(iMod, btkAcq[, scaleToMeter])	Compute joint power
CoordinateSystemDisplayFilter(iProc, iMod, ...)	Filter to display coordinate systems of a biomechanical model.
CentreOfMassFilter(iMod, btkAcq)	Filter for computing the center of mass (CoM) trajectory of a biomechanical model.
ModelMotionCorrectionFilter(procedure)	Filter for correcting the motion of a biomechanical model.
ModelQualityFilter(acq, procedure)	Filter for assessing the quality of the biomechanical model's motion.

Procedures

coordinate system

GeneralCoordinateSystemProcedure()	Procedure for defining general coordinate systems for segments in a biomechanical model.
ModelCoordinateSystemProcedure(iMod)	Procedure for handling model-specific coordinate systems.

calibration

GeneralCalibrationProcedure()	General Procedure to load from the Model Calibration Filter for custom models.
StaticCalibrationProcedure(model)	Procedure for calibration using a pyCGM2-embedded model instance.

inverse dynamics

InverseDynamicProcedure()
CGMLowerlimbInverseDynamicProcedure()	Procedure for calculating Inverse dynamics of the CGM lower limbs.

model quality

QualityProcedure()	Base class for quality assessment procedures of biomechanical models.
WandAngleQualityProcedure()	Procedure for assessing the quality of wand angle measurements in a biomechanical model.
GeneralScoreResidualProcedure(model)	Procedure for calculating SCORE residual on specific segments of a biomechanical model.
ModelScoreResidualProcedure(model)	Procedure for calculating SCORE residual for all joints of a biomechanical model.

model correction

ModelCorrectionProcedure()	Base class for model correction procedures.
Naim2019ThighMisaligmentCorrectionProcedure(...)	Corrects thigh anatomical frame alignment using the method described in Naim et al, 2019.

force plate integration

ForcePlateIntegrationProcedure()	Base class for procedures integrating force plate data.
GaitForcePlateIntegrationProcedure()	Procedure for integrating gait data with force plate information.

Decorators

Classes

DecoratorModel(iModel)	Base class for model decorators.
Kad(iModel, iAcq)	A decorator class for altering the knee joint centre using the Knee Alignment Device (KAD) method.
Cgm1ManualOffsets(iModel)	A decorator class for applying manual offsets to the CGM1 model.
HipJointCenterDecorator(iModel)	A decorator class for altering the hip joint center in the CGM model.
KneeCalibrationDecorator(iModel)	A decorator class for altering the hip joint center in the CGM model.
AnkleCalibrationDecorator(iModel)	A decorator class for altering the hip joint center in the CGM model.

functions

footJointCentreFromMet(acq, side, frameInit, ...)	Calculates foot center from metatarsal markers.
VCMJointCentre(HalfJoint, JointMarker, ...)	Calculates joint center according to Vicon Clinical Manager method.
chord(offset, A1, A2, A3[, beta, epsilon])	Calculates joint center using the 'chord' method.
midPoint(acq, lateralMarkerLabel, ...[, offset])	Returns the mid-point trajectory between two markers.
calibration2Dof(proxMotionRef, ...[, ...])	Calibration of 2 degrees of freedom (DOF).
saraCalibration(proxMotionRef, ...[, ...])	Computes a joint center position using the SARA method.
haraRegression(mp_input, mp_computed[, ...])	Implements the Hara et al. regression for hip joint center estimation.
harringtonRegression(mp_input, mp_computed, ...)	Implements the Harrington et al. regression for hip joint center estimation.
davisRegression(mp_input, mp_computed[, ...])	Implements the Davis et al. regression for hip joint center estimation.
bellRegression(mp_input, mp_computed[, ...])	Implements the Bell et al. regression for hip joint center estimation.