BTK Python wrapper  0.3dev.0
Python bindings for the Biomechanical ToolKit library (BTK)
Public Member Functions | List of all members
btk.btkForcePlatform Class Reference

Base class for all type of force platform. More...

Public Member Functions

def Begin
 
def Clone
 
def End
 
def GetCalMatrix
 
def GetChannel
 
def GetChannelNumber
 
def GetChannels
 
def GetCorner
 
def GetCorners
 
def GetOrigin
 
def GetTimestamp
 
def GetType
 
def SetCalMatrix
 
def SetChannel
 
def SetCorner
 
def SetCorners
 
def SetOrigin
 
def Update
 

Detailed Description

Base class for all type of force platform.

This class is generic and doesn't know its type, nor the number of analog channels used.
To use predefined force platform as proposed in the documentation of the C3D file format, check the following classes:
 - btk::ForcePlatformType1: 6 channels (FX, FY, FZ, PX, PY, MZ);
 - btk::ForcePlatformType2: 6 channels (FX, FY, FZ, MX, MY, MZ);
 - btk::ForcePlatformType3: 8 channels (FZ1, FZ2, FZ3, FZ4, FX12, FX34, FY14, FY23);
 - btk::ForcePlatformType4: Same as Type-2 + calibration matrix 6 (columns) by 6 (rows);
 - btk::ForcePlatformType5: Same as Type-3 + calibration matrix 6 (columns) by 8 (rows);
 - btk::ForcePlatformType6: 12 channels (FX[1,2,3,4], FY[1,2,3,4], FZ[1,2,3,4] + calibration matrix 12 by 12).

Member Function Documentation

def btk.btkForcePlatform.Begin (   self )
Begin(self) -> btkAnalogIterator

Returns an iterator to the beginning of the list of items.
def btk.btkForcePlatform.Clone (   self )
Clone(self) -> btkForcePlatform

Deep copy of the object.
def btk.btkForcePlatform.End (   self )
End(self) -> btkAnalogIterator

Returns an iterator just past the last item.
def btk.btkForcePlatform.GetCalMatrix (   self )
GetCalMatrix(self) -> array (NumPy)

Returns the calibration matrix.
def btk.btkForcePlatform.GetChannel (   self,   args  )
GetChannel(self, int) -> btkAnalog)

Returns the analog channel for the given index.
def btk.btkForcePlatform.GetChannelNumber (   self )
GetChannelNumber(self) -> int

Returns the number of analog channels used by the force platform.
def btk.btkForcePlatform.GetChannels (   self )
GetChannels(self) -> btkAnalogCollection

Returns force platform's channels.
def btk.btkForcePlatform.GetCorner (   self,   args  )
GetCorner(self, int) -> array (NumPy)

Returns the corner for the given index.
def btk.btkForcePlatform.GetCorners (   self )
GetCorners(self) -> array (NumPy)

Returns corners' coordinates.
def btk.btkForcePlatform.GetOrigin (   self )
GetOrigin(self) -> array (NumPy)

Returns the origin of the force platform.
def btk.btkForcePlatform.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

Returns the timestamp of the object.
def btk.btkForcePlatform.GetType (   self )
GetType(self) -> int

Returns the type of the force platform.
def btk.btkForcePlatform.SetCalMatrix (   self,   args  )
SetCalMatrix(self, array)

Sets the calibration matrix.
def btk.btkForcePlatform.SetChannel (   self,   args  )
SetChannel(self, int , btkAnalog)

Sets the analog channel for the given index.
def btk.btkForcePlatform.SetCorner (   self,   args  )
SetCorner(self, int, int, double)
SetCorner(self, int, double, double, double)
SetCorner(self, int, array)

Sets the corner for the given index.
def btk.btkForcePlatform.SetCorners (   self,   args  )
SetCorners(self, array)

Sets corners' coordinates.
def btk.btkForcePlatform.SetOrigin (   self,   args  )
SetOrigin(self, array)
SetOrigin(self, double, double, double)
      
Sets the origin.
def btk.btkForcePlatform.Update (   self )
Update(self)

Updates the ProcessObject associated with this DataObject.