CGM

class pyCGM2.Model.CGM2.cgm.CGM

Base Class of the Conventional Gait Model

__init__()

Methods

__init__()
addAnthropoInputParameters(iDict[, optional])	Add measured anthropometric data to the model.
addChain(label, indexSegmentList)	Add a segment chain to the model.
addJoint(label, proxLabel, distLabel, ...)	Add a joint to the model.
addSegment(label, index, sideEnum[, ...])	Add a segment to the model.
checkCalibrationProperty(...)	Check if a calibration property matches a specific value.
decomposeTrackingMarkers(acq, ...)	Decompose tracking markers to their components.
detectCalibrationMethods(acqStatic)	Class method to detect the method used to calibrate knee and ankle joint centres.
displayMotionCoordinateSystem(acqui, ...[, ...])	Display a motion coordinate system.
displayMotionViconCoordinateSystem(acqui, ...)	Display a motion Vicon coordinate system.
displayStaticCoordinateSystem(aquiStatic, ...)	Display a static coordinate system.
getBodyPart()	[Obsolete] Return the body part represented by the model.
getCentreOfMass()	Return the center of mass trajectory.
getClinicalDescriptor(dataType, ...[, ...])	Return a clinical descriptor.
getJoint(label)	Retrieve a Joint instance based on its label.
getJointList()	Retrieve a list of all joint labels.
getProperty(propertyLabel)	Return a specified property.
getSegment(label)	Retrieve a Segment instance based on its label.
getSegmentByIndex(index)	Retrieve a Segment instance based on its index.
getSegmentIndex(label)	Retrieve the index of a Segment based on its label.
getSegmentList()	Retrieve a list of all segment labels.
getStaticTrackingMarkers()	Get tracking markers.
get_markerLabelForPiGStatic(dcm)	Class method returning marker labels of the knee and ankle joint centres.
isCalibrationProperty(label)	Check if a calibration property exists by its label.
isProperty(label)	Check if a property exists by its label.
removeJoint(jointLabels)	Remove Joint instances based on their labels.
removeSegment(segmentLabels)	Remove Segment instances based on their labels.
setBodyPart(bodypart)	[Obsolete] Specify which body part is represented by the model.
setCalibrationProperty(propertyLabel, value)	Set or update a calibration property in the property dictionary.
setCentreOfMass(com)	Set the center of mass trajectory.
setClinicalDescriptor(jointOrSegmentLabel, ...)	Set a clinical descriptor.
setCoordinateSystemDefinition(segmentLabel, ...)	Set coordinate system definition.
setProperty(propertyLabel, value)	Set or update a property in the property dictionary.
setSTAexpertMode(boolFlag)	Set STA expert mode.
setStaticFilename(name)	Set the static filename used for static calibration.
setStaticTrackingMarkers(markers)	Set tracking markers.
updateSegmentFromCopy(targetLabel, segmentToCopy)	Update a segment from a copy of another segment instance.

Attributes

ANALYSIS_KINEMATIC_LABELS_DICT
ANALYSIS_KINETIC_LABELS_DICT
KAD_MARKERS
VERSIONS

classmethod detectCalibrationMethods(acqStatic: btkAcquisition) → Dict[str, JointCalibrationMethod]

Class method to detect the method used to calibrate knee and ankle joint centres.

Parameters:

acqStatic (btk.btkAcquisition) – btkAcquisition.

Returns:

Dict[str, JointCalibrationMethod] – Dictionary mapping joint names to calibration methods.

getStaticTrackingMarkers() → None | List[str]

Get tracking markers.

Returns:

Union[None, List[str]] – List of tracking markers or None if not set.

classmethod get_markerLabelForPiGStatic(dcm: Dict[str, JointCalibrationMethod]) → List[str]

Class method returning marker labels of the knee and ankle joint centres.

Parameters:

dcm (Dict[str, enums.JointCalibrationMethod]) – Dictionary returned from the function detectCalibrationMethods.

Returns:

List[str] – List of marker labels for knee and ankle joint centres.

setSTAexpertMode(boolFlag: bool) → None

Set STA expert mode.

Parameters:

boolFlag (bool) – Flag indicating whether to enable STA expert mode.

setStaticTrackingMarkers(markers: List[str]) → None

Set tracking markers.

Parameters:

markers (List[str]) – List of tracking markers.