ForcePlate#

class pyCGM2.Nexus.Devices.ForcePlate(NEXUS, id: str)#

Represents a force plate device in a pyCGM2-Nexus interface, extending the Device class.

forcePlateInfo#

Information about the force plate, such as origin and orientation.

__init__(NEXUS, id: str)#

Initializes the ForcePlate object with a Vicon Nexus handle and device ID.

Methods

__init__(NEXUS, id)

Initializes the ForcePlate object with a Vicon Nexus handle and device ID.

getContext()

Returns the context of the force plate, such as the side it represents.

getCorners()

Returns the coordinates of the corners of the force plate.

getDescription()

Returns a description of the force plate.

getDeviceFrequency()

Returns the sampling frequency of the device.

getDeviceName()

Returns the name of the device.

getForceUnit()

Returns the unit of measurement for the force data from the force plate.

getGlobalCoP()

Returns the Center of Pressure (CoP) from the force plate in global coordinates.

getGlobalForce()

Returns the force data from the force plate in global coordinates.

getGlobalMoment()

Returns the moment data from the force plate in global coordinates.

getLocalOrigin()

Returns the local origin of the force plate.

getLocalReactionForce()

Returns the reaction force from the force plate in local coordinates.

getLocalReactionMoment()

Returns the reaction moment from the force plate in local coordinates.

getMomentUnit()

Returns the unit of measurement for the moment data from the force plate.

getOrientation()

Returns the orientation of the force plate.

getOrigin()

Returns the origin of the force plate in global coordinates.

getOutputNames()

Returns a list of output names from the device.

getPhysicalOrigin()

Returns the physical origin location of the force plate.

getContext()#

Returns the context of the force plate, such as the side it represents.

Returns:

str – The context of the force plate.

getCorners()#

Returns the coordinates of the corners of the force plate.

Returns:

np.ndarray – The coordinates of the corners of the force plate.

getDescription()#

Returns a description of the force plate.

Returns:

str – A description of the force plate.

getForceUnit()#

Returns the unit of measurement for the force data from the force plate.

Returns:

str – The unit of force measurement.

getGlobalCoP()#

Returns the Center of Pressure (CoP) from the force plate in global coordinates.

Returns:

np.ndarray – The global CoP data from the force plate.

getGlobalForce()#

Returns the force data from the force plate in global coordinates.

Returns:

np.ndarray – The global force data from the force plate.

getGlobalMoment()#

Returns the moment data from the force plate in global coordinates.

Returns:

np.ndarray – The global moment data from the force plate.

getLocalOrigin()#

Returns the local origin of the force plate.

Returns:

np.ndarray – The local origin coordinates of the force plate.

getLocalReactionForce()#

Returns the reaction force from the force plate in local coordinates.

Returns:

np.ndarray – The local reaction force data from the force plate.

getLocalReactionMoment()#

Returns the reaction moment from the force plate in local coordinates.

Returns:

np.ndarray – The local reaction moment data from the force plate.

getMomentUnit()#

Returns the unit of measurement for the moment data from the force plate.

Returns:

str – The unit of moment measurement.

getOrientation()#

Returns the orientation of the force plate.

Returns:

np.ndarray – The orientation matrix of the force plate.

getOrigin()#

Returns the origin of the force plate in global coordinates.

Returns:

np.ndarray – The origin coordinates of the force plate.

getPhysicalOrigin()#

Returns the physical origin location of the force plate.

Returns:

np.ndarray – The physical origin coordinates of the force plate.