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

Represents a wrench as position, force and moment varying during the time. More...

Public Member Functions

def Clone
 
def GetComponent
 
def GetForce
 
def GetMoment
 
def GetPosition
 
def GetTimestamp
 
def SetForce
 
def SetFrameNumber
 
def SetMoment
 
def SetPosition
 
def Update
 

Detailed Description

Represents a wrench as position, force and moment varying during the time.

Represents a wrench as position, force and moment varying during the time.

This class is mainly used to have a compact way to store forces and moment acting (or reacting) at a given position.
The moment should be expressed at the position as it is defined in general mechanics.

By default, the label used for the forces and the moments corresponds to the given label followed by the suffix '.F' and '.M' respectively.

Warning: The call of the constructor btkWrench(label) must be followed by the use of the method btkWrench::SetFrameNumber as it creates a null matrix for the values.

Member Function Documentation

def btk.btkWrench.Clone (   self )
Clone(self) -> btkWrench
def btk.btkWrench.GetComponent (   self,   args  )
GetComponent(self, int) -> btkPoint)

Returns the component with the given index. The possible value for the index are: 0: Returns the position, 1: Returns the force, 2: Returns the moment. Any other value will trigger an exception.
def btk.btkWrench.GetForce (   self )
GetForce(self) -> btkPoint

Returns the wrench's force.
def btk.btkWrench.GetMoment (   self )
GetMoment(self) -> btkPoint

Returns the wrench's moment.
def btk.btkWrench.GetPosition (   self )
GetPosition(self) -> btkPoint

Returns the wrench's position.
def btk.btkWrench.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

Returns the timestamp of the object.
def btk.btkWrench.SetForce (   self,   args  )
SetForce(self, btkPoint)

Sets the wrench's moment.
def btk.btkWrench.SetFrameNumber (   self,   args  )
SetFrameNumber(self, int)

Set the number of frames in the wrenches. The given number of frames must be greater than 0.
def btk.btkWrench.SetMoment (   self,   args  )
SetMoment(self, btkPoint)
def btk.btkWrench.SetPosition (   self,   args  )
SetPosition(self, btkPoint)

Sets the wrench's position.
def btk.btkWrench.Update (   self )
Update(self)

Updates the ProcessObject associated with this DataObject.