KalmanInverseKinematicXmlCgmProcedure

class pyCGM2.Model.Opensim.interface.procedures.inverseKinematics.opensimInverseKinematicsInterfaceProcedure.KalmanInverseKinematicXmlCgmProcedure(DATA_PATH: str, scaledOsimName: str, resultsDirectory: str | None, modelVersion: str)

Procedure for handling Kalman-filter-based inverse kinematics in OpenSim for the CGM model. Extends InverseKinematicXmlProcedure with Kalman filter specific configurations.

Parameters:

• DATA_PATH (str) – The path to the data directory.

• scaledOsimName (str) – The name of the scaled OpenSim model file.

• resultsDirectory (Optional[str]) – The directory for storing results.

• modelVersion (str) – The version of the CGM model.

__init__(DATA_PATH: str, scaledOsimName: str, resultsDirectory: str | None, modelVersion: str)

Methods

__init__(DATA_PATH, scaledOsimName, ...)
finalize()	Finalizes the Kalman-filter-based inverse kinematics procedure, including file renaming and cleanup.
getXml()	Retrieves the XML associated with the procedure.
prepareTrial_fromBtkAcq(acq, dynamicFile, ...)	Prepares a trial from a BTK acquisition for inverse kinematics analysis.
prepareWeights(weights_dict)	Adjusts and sets the marker weights for the Kalman-filter-based inverse kinematics analysis.
prepareXml()	Prepares the XML configuration for the inverse kinematics analysis.
run()	Runs the Kalman-filter-based inverse kinematics analysis using a CGM model.
setAccuracy(value)	Sets the accuracy for the inverse kinematics analysis.
setFrameRange(begin, end)	Sets the frame range for the inverse kinematics analysis.
setModelVersion(modelVersion)	Sets the model version.
setResultsDirname(dirname)	Sets the directory name where the results will be stored.
setSetupFile(ikToolFile)	Sets up the IK tool file for the inverse kinematics analysis.
setTimeRange(begin, end)	Sets the time range for the inverse kinematics analysis.

finalize()

Finalizes the Kalman-filter-based inverse kinematics procedure, including file renaming and cleanup.

prepareWeights(weights_dict: Dict[str, float]) → None

Adjusts and sets the marker weights for the Kalman-filter-based inverse kinematics analysis.

Parameters:

weights_dict (Dict[str, float]) – A dictionary mapping marker names to their weights.

run()

Runs the Kalman-filter-based inverse kinematics analysis using a CGM model.