StaticOptimisationXmlCgmProcedure

class pyCGM2.Model.Opensim.interface.procedures.staticOptimisation.opensimStaticOptimizationInterfaceProcedure.StaticOptimisationXmlCgmProcedure(DATA_PATH: str, scaledOsimName: str, modelVersion: str, resultsDirectory: str | None)

Specialized procedure for handling static optimization analyses in OpenSim, specifically tailored for CGM models.

This class extends StaticOptimisationXmlProcedure to include configurations and customizations necessary for CGM model versions in static optimization analyses.

Parameters:

• DATA_PATH (str) – Path to the data directory.

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

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

• resultsDirectory (Optional[str]) – Directory for storing results. If None, defaults to DATA_PATH.

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

Methods

__init__(DATA_PATH, scaledOsimName, ...)
finalize()	Finalizes the process, including renaming and cleanup of the setup files.
getXml()	Retrieves the XML associated with the procedure.
prepareTrial_fromBtkAcq(acq, dynamicFile, ...)	Prepares the trial data from a BTK acquisition for static optimization analysis.
prepareXml()	Prepares the XML configuration for the Static Optimization Tool in OpenSim.
run()	Executes the static optimization analysis using the configured XML files.
setFrameRange(begin, end)	Sets the frame range for the static optimization analysis.
setModelVersion(modelVersion)	Sets the model version.
setResultsDirname(dirname)	Sets the results directory name.
setSetupFiles(analysisToolTemplateFile, ...)	Sets up the file paths for the Static Optimization tool and external load file.
setTimeRange(begin, end)	Sets the time range for the static optimization analysis.

finalize()

Finalizes the process, including renaming and cleanup of the setup files.

prepareXml()

Prepares the XML configuration for the Static Optimization Tool in OpenSim.