opensimInterfaceAnalysesFilter

class pyCGM2.Model.Opensim.interface.opensimInterfaceFilters.opensimInterfaceAnalysesFilter(procedure: AnalysesXmlCgmProcedure)

Filter interface for OpenSim Analysis Report.

Parameters:

procedure (AnalysesXmlCgmProcedure) – The analysis report procedure to be applied.

__init__(procedure: AnalysesXmlCgmProcedure)

Methods

__init__(procedure)
getAcq()	Retrieves the BTK acquisition instance where the procedure results are stored.
pushStoToAcq([type, outputs])	Pushes STO file data to BTK acquisition.
run()	Runs the defined procedure.

getAcq()

Retrieves the BTK acquisition instance where the procedure results are stored.

Returns:

Optional[btk.btkAcquisition] – The BTK acquisition instance, if available.

pushStoToAcq(type: str = 'MuscleAnalysis', outputs: List[str] = ['Length']) → None

Pushes STO file data to BTK acquisition.

Parameters:

• type (str) – The type of analysis to be processed (e.g., “MuscleAnalysis”).

• outputs (List[str]) – A list of outputs to be processed. The available options for “MuscleAnalysis” are: - MuscleActuatorPower - NormalizedFiberLength - NormFiberVelocity - PassiveFiberForce - PassiveFiberForceAlongTendon - PennationAngle - PennationAngularVelocity - TendonForce - TendonLength - TendonPower - ActiveFiberForce - ActiveFiberForceAlongTendon - FiberActivePower - FiberForce - FiberLength - FiberPassivePower - FiberVelocity - Length

Raises:

ValueError – If the acquisition is not available or if the specified ‘type’ or ‘outputs’ are invalid.

run()

Runs the defined procedure.