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

Detect heel strike and toe-off events during gait from vertical ground reaction wrench. More...

Public Member Functions

def GetAcquisitionInformation
 
def GetForceplateContextMapping
 
def GetInput
 
def GetInputNumber
 
def GetOutput
 
def GetOutputNumber
 
def GetRegionOfInterest
 
def GetThresholdValue
 
def GetTimestamp
 
def GetValidInputNumber
 
def ResetState
 
def SetAcquisitionInformation
 
def SetForceplateContextMapping
 
def SetInput
 
def SetRegionOfInterest
 
def SetThresholdValue
 
def Update
 

Detailed Description

Detect heel strike and toe-off events during gait from vertical ground reaction wrench.

Proxy of C++ btkVerticalGroundReactionForceGaitEventDetector class

Member Function Documentation

def btk.btkVerticalGroundReactionForceGaitEventDetector.GetAcquisitionInformation (   self,   args  )
GetAcquisitionInformation(int& ff, double& sampleRate, string& subjectLabel)

Returns the informations required to set correctly the detected events.
def btk.btkVerticalGroundReactionForceGaitEventDetector.GetForceplateContextMapping (   self )
GetForceplateContextMapping(self) -> btkStringArray

Returns the mapping between the wrenches in the input and the gait events to detect.
def btk.btkVerticalGroundReactionForceGaitEventDetector.GetInput (   self )
GetInput(self) -> btkWrenchCollection

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

Returns the number of inputs.
def btk.btkVerticalGroundReactionForceGaitEventDetector.GetOutput (   self )
GetOutput(self) -> btkEventCollection

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

Returns the number of outputs.
def btk.btkVerticalGroundReactionForceGaitEventDetector.GetRegionOfInterest (   self )
GetRegionOfInterest(self) -> int const *

Returns the region of interest to use to detect gait events.
def btk.btkVerticalGroundReactionForceGaitEventDetector.GetThresholdValue (   self )
GetThresholdValue(self) -> int

Returns the threshold used to detect gait events.
def btk.btkVerticalGroundReactionForceGaitEventDetector.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

Returns the timestamp of the object.
def btk.btkVerticalGroundReactionForceGaitEventDetector.GetValidInputNumber (   self )
GetValidInputNumber(self) -> int

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

Reset the state of the process. Usefull when an exception was thrown during the generation of the data.
def btk.btkVerticalGroundReactionForceGaitEventDetector.SetAcquisitionInformation (   self,   args  )
SetAcquisitionInformation(int& ff, double& sampleRate, string& subjectLabel)

Set the informations required to set correctly the detected events.
def btk.btkVerticalGroundReactionForceGaitEventDetector.SetForceplateContextMapping (   self,   args  )
SetForceplateContextMapping(self, arg2)

Sets the mapping between the given wrenches and the side of the detected events. If no mapping is given, then all the detected events will be set as 'General' events.
def btk.btkVerticalGroundReactionForceGaitEventDetector.SetInput (   self,   args  )
SetInput(self, arg2)
SetInput(self, arg2)

Sets the input required with this process.
def btk.btkVerticalGroundReactionForceGaitEventDetector.SetRegionOfInterest (   self,   args  )
SetRegionOfInterest(self, lb=-1, ub=-1)
SetRegionOfInterest(self, lb=-1)
SetRegionOfInterest(self)

Sets the region of interest to use to detect gait events.
WARNING: The boundaries must be set using zero-based indices.
def btk.btkVerticalGroundReactionForceGaitEventDetector.SetThresholdValue (   self,   args  )
SetThresholdValue(self, arg2)

Sets the threshold used to detect gait events.
def btk.btkVerticalGroundReactionForceGaitEventDetector.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.