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

Remove a possible analog offset to the selected analog channels. More...

Public Member Functions

def GetInputNumber
 
def GetOffsetInput
 
def GetOutput
 
def GetOutputNumber
 
def GetRawInput
 
def GetTimestamp
 
def GetValidInputNumber
 
def ResetState
 
def SetOffsetInput
 
def SetRawInput
 
def Update
 

Detailed Description

Remove a possible analog offset to the selected analog channels.

Remove a possible analog offset to the selected analog channels

Based on the given offset input (see the method SetOffsetInput()), each analog signals
are averaged and removed from the raw input (see the method SetRawInput()). The analog signals set in the raw input which
are not given to the offset input are not processed but will be available in the output.

Member Function Documentation

def btk.btkAnalogOffsetRemover.GetInputNumber (   self )
GetInputNumber(self) -> int

Returns the number of inputs.
def btk.btkAnalogOffsetRemover.GetOffsetInput (   self )
GetOffsetInput(self) -> btkAcquisition

Gets the input registered with this process which corresponds to the offsets to remove.
def btk.btkAnalogOffsetRemover.GetOutput (   self )
GetOutput(self) -> btkAcquisition

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

Returns the number of outputs.
def btk.btkAnalogOffsetRemover.GetRawInput (   self )
GetRawInput(self) -> btkAcquisition

Gets the input registered with this process which is used as the input to process.
def btk.btkAnalogOffsetRemover.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

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

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

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

Sets the input required with this process which corresponds to the offsets to remove.
def btk.btkAnalogOffsetRemover.SetRawInput (   self,   args  )
SetRawInput(self, btkAcquisition)

Sets the input required with this process which is used as the input to process.
def btk.btkAnalogOffsetRemover.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.