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

Transform force platform data into ground reaction wrenches. More...

Public Member Functions

def GetInput
 
def GetInputNumber
 
def GetOutput
 
def GetOutputNumber
 
def GetThresholdState
 
def GetThresholdValue
 
def GetTimestamp
 
def GetTransformToGlobalFrame
 
def GetValidInputNumber
 
def ResetState
 
def SetInput
 
def SetThresholdState
 
def SetThresholdValue
 
def SetTransformToGlobalFrame
 
def Update
 

Detailed Description

Transform force platform data into ground reaction wrenches.

Transform force platform data into ground reaction wrenches.

Theses wrenches are expressed in the global frame. The point of application (PWA)
of each wrench is calculated from the paper of Shimba (1984). 
Compared to the center of pressure (COP), the PWA take into account all the forces
and moments (and does not assume any null forces).

Note: For gait analysis, the COP and PWA are very similar.
Because the computation of the PWA (as the COP) is sensitive to small (vertical) forces, the methods 
SetThresholdValue and SetThresholdState() are provided to not compute the PWA if the vertical forces is
the threshold. You first need to set the value and then activate the threshold method.
By default, this threshold is not activated and the values is set to 0.

# Example
grwf = btk.btkGroundReactionWrenchFilter()
grwf.SetThresholdValue(5.0); # 5 newtons
grwf.SetThresholdState(true);

Finally, you can also use the method btkGroundReactionWrenchFilter::SetTransformToGlobalFrame() to have the wrench expressed in the frame of the force platform.

Member Function Documentation

def btk.btkGroundReactionWrenchFilter.GetInput (   self )
GetInput(self) -> btkForcePlatformCollection

Gets the input registered with this process.
def btk.btkGroundReactionWrenchFilter.GetInputNumber (   self )
GetInputNumber(self) -> int

Returns the number of inputs.
def btk.btkGroundReactionWrenchFilter.GetOutput (   self )
GetOutput(self) -> btkWrenchCollection

Returns the output created with this process.
def btk.btkGroundReactionWrenchFilter.GetOutputNumber (   self )
GetOutputNumber(self) -> int

Returns the number of outputs.
def btk.btkGroundReactionWrenchFilter.GetThresholdState (   self )
GetThresholdState(self) -> bool

Returns the state of the threshold used to suppress false PWA.
def btk.btkGroundReactionWrenchFilter.GetThresholdValue (   self )
GetThresholdValue(self) -> double

Returns the value used to suppress PWA computed with a Fz value lower or equal than it.
def btk.btkGroundReactionWrenchFilter.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

Returns the timestamp of the object.
def btk.btkGroundReactionWrenchFilter.GetTransformToGlobalFrame (   self )
GetTransformToGlobalFrame(self) -> bool

Returns the state of the activation for the computation of the wrenches in the global frame.
def btk.btkGroundReactionWrenchFilter.GetValidInputNumber (   self )
GetValidInputNumber(self) -> int

Returns the number of inputs which are valid (i.e. not null).
def btk.btkGroundReactionWrenchFilter.ResetState (   self )
ResetState(self)

Reset the state of the process. Usefull when an exception was thrown during the generation of the data.
def btk.btkGroundReactionWrenchFilter.SetInput (   self,   args  )
SetInput(self, btkForcePlatform)
SetInput(self, btkForcePlatformCollection)

Sets the input required with this process.
def btk.btkGroundReactionWrenchFilter.SetThresholdState (   self,
  activated = False 
)
SetThresholdState(self, activated=False)
SetThresholdState(self)

Sets the threshold state.
def btk.btkGroundReactionWrenchFilter.SetThresholdValue (   self,   args  )
SetThresholdValue(self, double)

Sets the threshold value.
def btk.btkGroundReactionWrenchFilter.SetTransformToGlobalFrame (   self,
  activation = False 
)
SetTransformToGlobalFrame(self, activation=False)
SetTransformToGlobalFrame(self)

Activate or deactivate the computation of the wrenches in the global frame.
def btk.btkGroundReactionWrenchFilter.Update (   self )
Update(self)

Update the pipeline and then all the data inside. Recursive method which
 1) determines the processes to update
 2) generate the data by using the GenerateData() method.