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

Separate a collection of points in five categories to be able to distinguish real markers from the others. More...

Public Member Functions

def AppendVirtualMarker
 
def AppendVirtualMarkers
 
def AppendVirtualReferenceFrame
 
def AppendVirtualReferenceFrames
 
def GetInput
 
def GetInputNumber
 
def GetLabelPrefix
 
def GetOutput
 
def GetOutputNumber
 
def GetTimestamp
 
def GetValidInputNumber
 
def GetVirtualMarkers
 
def GetVirtualReferenceFrames
 
def ResetState
 
def SetInput
 
def SetLabelPrefix
 
def SetVirtualMarkers
 
def SetVirtualReferenceFrames
 
def Update
 

Static Public Attributes

 AllMarkers = _btk.btkSeparateKnownVirtualMarkersFilter_AllMarkers
 
 Markers = _btk.btkSeparateKnownVirtualMarkersFilter_Markers
 
 OtherPoints = _btk.btkSeparateKnownVirtualMarkersFilter_OtherPoints
 
 VirtualMarkers = _btk.btkSeparateKnownVirtualMarkersFilter_VirtualMarkers
 
 VirtualReferenceFrames = _btk.btkSeparateKnownVirtualMarkersFilter_VirtualReferenceFrames
 

Detailed Description

Separate a collection of points in five categories to be able to distinguish real markers from the others.

Separate a collection of points in five categories to be able to distinguish real markers from the others.

These categories are:
 - all kind of markers (real and virtual) as stored in the acquisition
 - markers
 - virtual markers used to construct refence frames
 - other virtual markers (CenterOfMass, ...)
 - other points (angle, force, moment, power, ...)

To select the output corresponding to the chosen category, you can use the method GetOutput() 
with one of these enum values: AllMarkers, Markers, VirtualReferenceFrames, VirtualMarkers, OtherPoints.

By default, the list of labels known as virtual markers used for frame is:
 - HED(O|A|L|P): HEDO, HEDA, HEDL, HELP
 - LCL(O|A|L|P)
 - LFE(O|A|L|P)
 - LFO(O|A|L|P)
 - LHN(O|A|L|P)
 - LHU(O|A|L|P)
 - LRA(O|A|L|P)
 - LTI(O|A|L|P)
 - LTO(O|A|L|P)
 - PEL(O|A|L|P)
 - RCL(O|A|L|P)
 - RFE(O|A|L|P)
 - RFO(O|A|L|P)
 - RHN(O|A|L|P)
 - RHU(O|A|L|P)
 - RRA(O|A|L|P)
 - RTI(O|A|L|P)
 - RTO(O|A|L|P)
 - TRX(O|A|L|P)

By default, the list of labels known as other virtual markers is:
 - CenterOfMass
 - CenterOfMassFloor

You can also add a prefix for the markers' label by using the method SetLabelPrefix. This prefix will be concatenated to the markers' label during the separation.

This filter only copies the pointer associated which each point instead of using a deep copy of it.

Member Function Documentation

def btk.btkSeparateKnownVirtualMarkersFilter.AppendVirtualMarker (   self,   args  )
AppendVirtualMarker(self, string)

Append a label in the category of the other virtual markers.
def btk.btkSeparateKnownVirtualMarkersFilter.AppendVirtualMarkers (   self,   args  )
AppendVirtualMarkers(self, btkStringList)

Append a list of labels in the category of the other virtual markers.
def btk.btkSeparateKnownVirtualMarkersFilter.AppendVirtualReferenceFrame (   self,   args  )
AppendVirtualReferenceFrame(self, string, string, string, string)
AppendVirtualReferenceFrame(self, btkStringAxes)

Append a new set of labels for a virtual frame.
def btk.btkSeparateKnownVirtualMarkersFilter.AppendVirtualReferenceFrames (   self,   args  )
AppendKnownVirtualMarkerLabelForAxes(self, btkStringAxesList)

Append a list of axes' definition in the category of the virtual markers used to defined frames.
def btk.btkSeparateKnownVirtualMarkersFilter.GetInput (   self )
GetInput(self) -> btkPointCollection

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

Returns the number of inputs.
def btk.btkSeparateKnownVirtualMarkersFilter.GetLabelPrefix (   self )
GetLabelPrefix(self) -> std::string const &

Returns the prefix which will be concatenated to the markers' label during the separation.
def btk.btkSeparateKnownVirtualMarkersFilter.GetOutput (   self,   args  )
GetOutput(self, int) -> btkPointCollection

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

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

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

Returns the number of inputs which are valid (i.e. not null).
def btk.btkSeparateKnownVirtualMarkersFilter.GetVirtualMarkers (   self )
GetVirtualMarkers(self) -> btkStringList

Returns the list of labels for the virtual markers used in another context than virtual frames
def btk.btkSeparateKnownVirtualMarkersFilter.GetVirtualReferenceFrames (   self )
GetVirtualReferenceFrames(self) -> btkStringAxesList

Returns the list of labels for the virtual markers used to create frame.
def btk.btkSeparateKnownVirtualMarkersFilter.ResetState (   self )
ResetState(self)

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

Sets the input required with this process.
def btk.btkSeparateKnownVirtualMarkersFilter.SetLabelPrefix (   self,   args  )
SetLabelPrefix(self, string)

Sets the prefix which will be concatenated to the markers' label during the separation.
def btk.btkSeparateKnownVirtualMarkersFilter.SetVirtualMarkers (   self,   args  )
SetKnownVirtualMarkerLabelsForOthers(self, btkStringList)

Sets the list of labels for the virtual markers used in another context than virtual frames. Each label is checked before to be inserted to not have duplication.
def btk.btkSeparateKnownVirtualMarkersFilter.SetVirtualReferenceFrames (   self,   args  )
SetKnownVirtualMarkerLabelsForAxes(self, btkStringAxesList)

Sets the list of labels for the virtual markers used to create frames.
def btk.btkSeparateKnownVirtualMarkersFilter.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.

Member Data Documentation

btk.btkSeparateKnownVirtualMarkersFilter.AllMarkers = _btk.btkSeparateKnownVirtualMarkersFilter_AllMarkers
static

Contains all kind of markers (real and virtual) as stored in the acquisition

btk.btkSeparateKnownVirtualMarkersFilter.Markers = _btk.btkSeparateKnownVirtualMarkersFilter_Markers
static

Contains only real markers.

btk.btkSeparateKnownVirtualMarkersFilter.OtherPoints = _btk.btkSeparateKnownVirtualMarkersFilter_OtherPoints
static

Contains all the other points (i.e angle, force, moment, power, etc.)

btk.btkSeparateKnownVirtualMarkersFilter.VirtualMarkers = _btk.btkSeparateKnownVirtualMarkersFilter_VirtualMarkers
static

Contains only virtual markers no used for frames (e.g center of mass)

btk.btkSeparateKnownVirtualMarkersFilter.VirtualReferenceFrames = _btk.btkSeparateKnownVirtualMarkersFilter_VirtualReferenceFrames
static

Contains only virtual markers used to create frames