BTK Matlab Wrapper  0.3dev.0
Matlab bindings for the Biomechanical ToolKit library (BTK)
btkRemoveEvent Class Reference

Description

Delete events corresponding to the given criterias.

Syntax:
[events, eventsInfo] = btkRemoveEvent(h, index)
[events, eventsInfo] = btkRemoveEvent(h, option, value, ...)
Parameters
hHandle pointing to a C++ btk::Acquisition object.
indexPosition of the event starting from 1.
optionString to filter the events to remove (check the detailed description for more information).
valueValue associated with the given option.
...More couple of option/value to filter the events to remove.
Return values
eventsA structure with the same format than in the function btkGetEvents
eventsInfoA structure with the same format than in the function btkGetEvents
Detailed description:
btkRemoveEvent(h) corresponds to the function btkClearEvents. btkRemoveEvent(h, index) removes the events at the index index. btkRemoveEvent(h, option, value, ...) removes only event(s) described by the given options. There are four options which can combined to refine the request.
  • 'Time' followed by a single real value delete all events with this time +/- 0.00005 seconds
  • 'Label' followed by a string delete all events which have this label
  • 'Context' followed by a string delete all events which contains this context's name
  • 'Subject' followed by a string delete all events which contains this subject's name The combination of several options only delete events which match all criterias.
See Also
btkRemoveAnalog, btkRemoveAnalysisParameterm, btkRemoveMetaData, btkRemovePoint