InverseDynamicsXmlCgmProcedure#

class pyCGM2.Model.Opensim.interface.procedures.inverseDynamics.opensimInverseDynamicsInterfaceProcedure.InverseDynamicsXmlCgmProcedure(DATA_PATH: str, scaledOsimName: str, resultsDirectory: str | None, modelVersion: str)#

Specialized procedure for handling inverse dynamics analyses in OpenSim, specifically tailored for CGM models.

This class extends InverseDynamicsXmlProcedure to include configurations and customizations necessary for CGM model versions.

Parameters:

DATA_PATH (str) – Path to the data directory.
scaledOsimName (str) – Name of the scaled OpenSim model file.
resultsDirectory (Optional[str]) – Directory for storing results. If None, defaults to DATA_PATH.
modelVersion (str) – The version of the CGM model to be used.

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

Methods

`__init__`(DATA_PATH, scaledOsimName, ...)
`finalize`()	Finalizes the CGM model-specific inverse dynamics process, including renaming and cleanup of setup files.
`getXml`()	Retrieves the XML associated with the procedure.
`prepareTrial_fromBtkAcq`(acq, dynamicFile, ...)	Prepares the trial data from a BTK acquisition for inverse dynamics analysis.
`prepareXml`()	Prepares the XML configuration specific to the CGM model for the Inverse Dynamics Tool in OpenSim.
`run`()	Executes the inverse dynamics analysis using the configured XML files, specifically tailored for the CGM model.
`setFrameRange`(begin, end)	Sets the frame range for the inverse dynamics analysis.
`setModelVersion`(modelVersion)	Sets the model version.
`setResultsDirname`(dirname)	Sets the directory name where the results will be stored.
`setSetupFiles`(idToolTemplateFile, ...)	Sets up the necessary files for inverse dynamics analysis.
`setTimeRange`(begin, end)	Sets the time range for the inverse dynamics analysis.

finalize()#: Finalizes the CGM model-specific inverse dynamics process, including renaming and cleanup of setup files.

prepareXml()#

Prepares the XML configuration specific to the CGM model for the Inverse Dynamics Tool in OpenSim.

Customizes the XML settings to align with the specifics of the CGM model version being used.

run()#: Executes the inverse dynamics analysis using the configured XML files, specifically tailored for the CGM model.