AnkleCalibrationDecorator#
- class pyCGM2.Model.modelDecorator.AnkleCalibrationDecorator(iModel: Model)#
A decorator class for altering the hip joint center in the CGM model.
- Parameters:
iModel (Model) – An instance of pyCGM2 model.
Methods
__init__
(iModel)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.
displayMotionCoordinateSystem
(acqui, ...[, ...])Display a motion coordinate system.
displayMotionViconCoordinateSystem
(acqui, ...)Display a motion Vicon coordinate system.
displayStaticCoordinateSystem
(aquiStatic, ...)Display a static coordinate system.
fromAjcMarker
(acq[, leftAJC_label, ...])Positions ankle joint centers from virtual AJC marker trajectories computed from another process.
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.
isCalibrationProperty
(label)Check if a calibration property exists by its label.
isProperty
(label)Check if a property exists by its label.
midMaleolus
(acq[, side, ...])Compute the ankle joint centre from mid malleolus.
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.
setStaticFilename
(name)Set the static filename used for static calibration.
updateSegmentFromCopy
(targetLabel, segmentToCopy)Update a segment from a copy of another segment instance.
- fromAjcMarker(acq: btkAcquisition, leftAJC_label: str = 'LAJC', rightAJC_label: str = 'RAJC', side: str = 'both') None #
Positions ankle joint centers from virtual AJC marker trajectories computed from another process.
- Parameters:
acq (btk.btkAcquisition) – An acquisition with virtual AJC marker trajectories.
leftAJC_label (str, optional) – Label of the left virtual AJC marker. Defaults to “LAJC”.
rightAJC_label (str, optional) – Label of the right virtual AJC marker. Defaults to “RAJC”.
side (str, optional) – Body side to apply the method (‘left’, ‘right’, or ‘both’). Defaults to “both”.
- midMaleolus(acq: btkAcquisition, side: str = 'both', leftLateralAnkleLabel: str = 'LANK', leftMedialAnkleLabel: str = 'LMED', rightLateralAnkleLabel: str = 'RANK', rightMedialAnkleLabel: str = 'RMED', markerDiameter: float = 14, widthFromMp: bool = True) None #
Compute the ankle joint centre from mid malleolus.
- Parameters:
acq (btk.btkAcquisition) – An acquisition.
side (str, optional) – Body side to apply the method (‘left’, ‘right’, or ‘both’). Defaults to “both”.
leftLateralAnkleLabel (str, optional) – Label of the left lateral ankle marker. Defaults to “LANK”.
leftMedialAnkleLabel (str, optional) – Label of the left medial ankle marker. Defaults to “LMED”.
rightLateralAnkleLabel (str, optional) – Label of the right lateral ankle marker. Defaults to “RANK”.
rightMedialAnkleLabel (str, optional) – Label of the right medial ankle marker. Defaults to “RMED”.
markerDiameter (float, optional) – Diameter of the marker. Defaults to 14.
widthFromMp (bool, optional) – Use ankle width from model anthropometric parameters. Defaults to True.