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

Extracts inertial measurement units (IMUs) from a btkAcquisition object. More...

Public Member Functions

def GetInput
 
def GetInputNumber
 
def GetOutput
 
def GetOutputNumber
 
def GetTimestamp
 
def GetValidInputNumber
 
def ResetState
 
def SetInput
 
def Update
 

Detailed Description

Extracts inertial measurement units (IMUs) from a btkAcquisition object.

Extracts inertial measurement units (IMUs) from a btkAcquisition object. 

Based on the content of the metadata IMU and the analog channels stored in the given acquisition(s),
this filter creates a collection of btkIMU returned in the output.

The metadata IMU must be structured as the following:
 - IMU:USED: single integer storing the number of IMUs ;
 - IMU:TYPE: 1D array of integer containing the type of IMU contained in the acquisition (see below for the supported types) ;
 - IMU:CHANNEL: 2D array of integer containing of 1-based indices of the analog channels used ;
 - IMU:LABELS: 1D array of strings containing the force plates' label ;
 - IMU:DESCRIPTIONS: 1D array of strings containing the force plates' description ;

The supported types are the following:
 - Type 1: 6D IMU with a 3D accelerometer and 3D gyroscope.

Note: This class is still experimental and could be modified in the next release.

Member Function Documentation

def btk.btkIMUsExtractor.GetInput (   self,   args  )
GetInput(self) -> btkAcquisition
GetInput(self, int) -> btkAcquisition

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

Returns the number of inputs.
def btk.btkIMUsExtractor.GetOutput (   self )
GetOutput(self) -> btkIMUCollection

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

Returns the number of outputs.
def btk.btkIMUsExtractor.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

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

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

Reset the state of the process. Usefull when an exception was thrown during the generation of the data.
def btk.btkIMUsExtractor.SetInput (   self,   args  )
SetInput(self, btkAcquisition)
SetInput(self, int, btkAcquisition)

Sets the input required with this process.
def btk.btkIMUsExtractor.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.