HipJointCenterDecorator#

class pyCGM2.Model.modelDecorator.HipJointCenterDecorator(iModel: Model)#

A decorator class for altering the hip joint center in the CGM model.

Parameters:: iModel (Model) – An instance of pyCGM2 model.

__init__(iModel: 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.
`bell`([side])	Uses the Bell's regressions for hip joint center estimation.
`checkCalibrationProperty`(...)	Check if a calibration property matches a specific value.
`custom`([position_Left, position_Right, ...])	Locates hip joint centers manually.
`davis`([side])	Uses the Davis's regressions for hip joint center estimation.
`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.
`fromHjcMarker`(acq[, leftHJC_label, ...])	Positions hip joint centers from virtual HJC 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.
`greatTrochanterOffset`(acq[, offset, side, ...])	Computes the hip joint center from the great trochanter offset.
`hara`([side])	Uses the Hara's regressions for hip joint center estimation.
`harrington`([predictors, side])	Uses the Harrington's regressions for hip joint center estimation.
`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.
`setStaticFilename`(name)	Set the static filename used for static calibration.
`updateSegmentFromCopy`(targetLabel, segmentToCopy)	Update a segment from a copy of another segment instance.

bell(side: str = 'both') → None#

Uses the Bell’s regressions for hip joint center estimation.

Parameters:: side (str, optional) – Body side to apply the method (‘left’, ‘right’, or ‘both’). Defaults to “both”.

custom(position_Left: ndarray | list = 0, position_Right: ndarray | list = 0, side: str = 'both', methodDesc: str = 'custom')#

Locates hip joint centers manually. Be sure you construct the pelvis coordinate system in accordance with the CGM guidelines.

Parameters:

position_Left (Union[np.ndarray, list]) – Position of the left hip center in the pelvis referential.
position_Right (Union[np.ndarray, list]) – Position of the right hip center in the pelvis referential.
side (str, optional) – Side of the body (‘left’, ‘right’, or ‘both’). Defaults to “both”.
methodDesc (str, optional) – Short description of the method. Defaults to “custom”.

davis(side: str = 'both') → None#

Uses the Davis’s regressions for hip joint center estimation.

Parameters:: side (str, optional) – Body side to apply the method (‘left’, ‘right’, or ‘both’). Defaults to “both”.

fromHjcMarker(acq: btkAcquisition, leftHJC_label: str = 'LHJC', rightHJC_label: str = 'RHJC', side: str = 'both') → None#

Positions hip joint centers from virtual HJC marker trajectories computed from another process.

Parameters:

acq (btk.btkAcquisition) – An acquisition with virtual HJC marker trajectories.
leftHJC_label (str, optional) – Label of the left virtual HJC marker. Defaults to “LHJC”.
rightHJC_label (str, optional) – Label of the right virtual HJC marker. Defaults to “RHJC”.
side (str, optional) – Body side to apply the method (‘left’, ‘right’, or ‘both’). Defaults to “both”.

greatTrochanterOffset(acq: btkAcquisition, offset: float = 89.0, side: str = 'both', leftGreatTrochLabel: str = 'LGTR', rightGreatTrochLabel: str = 'LKNM', markerDiameter: float = 14.0) → None#

Computes the hip joint center from the great trochanter offset.

Parameters:

acq (btk.btkAcquisition) – An acquisition.
offset (float, optional) – Distance in mm for positioning axis boundaries. Defaults to 89.0.
side (str, optional) – Body side to apply the method (‘left’, ‘right’, or ‘both’). Defaults to “both”.
leftGreatTrochLabel (str, optional) – Label of the left great trochanter marker. Defaults to “LGTR”.
rightGreatTrochLabel (str, optional) – Label of the right great trochanter marker. Defaults to “LKNM”.
markerDiameter (float, optional) – Diameter of the marker. Defaults to 14.0.

hara(side: str = 'both') → None#

Uses the Hara’s regressions for hip joint center estimation.

Parameters:: side (str, optional) – Body side to apply the method (‘left’, ‘right’, or ‘both’). Defaults to “both”.

harrington(predictors: HarringtonPredictor = HarringtonPredictor.Native, side: str = 'both') → None#

Uses the Harrington’s regressions for hip joint center estimation.

Parameters:

predictors (enums.HarringtonPredictor, optional) – Harrington’s predictors to use. Defaults to enums.HarringtonPredictor.Native.
side (str, optional) – Body side to apply the method (‘left’, ‘right’, or ‘both’). Defaults to “both”.