Scripting API

btkGetEvents

Module BTKEventAccessor

Description#

Extracts events from a biomechanical acquisition.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.

Returned Values#

eventsstructure where each field corresponds to an event's label
eventsInfostructure with additional informations
  • eventsInfo.subjects: contains the name of the subject for each event
  • eventsInfo.units: structure with a single field named ALLEVENTS for the unit used by the events.

Detailed Description#

The value of each field in the output event corresponds to the time(s) where this event occurred. If the events represent actions realized by more than one subject, each event starts by the name of the corresponding subject. The time(s) of each event are reordered. Events are also reordered based on their first time. Events' time are computed using the following formula: t = (event_frame - first_frame) / sample_frequency Hence, an event set to the first frame of the acquisition, will have a (relative) time computed to 0.0 second.

Notes#

See also#

Syntax#

[events, eventsInfo] = btkGetEvents(h)

Examples#