pymovements.events.events.Event

class pymovements.events.events.Event(name: str, onset: int, offset: int)

Base Event class.

name

Name of event.

Type:

str

onset

Starting index of event (included).

Type:

int

offset

Ending index of event (excluded).

Type:

int

schema

Schema for event DataFrame.

Type:

polars.SchemaDict

__init__(name: str, onset: int, offset: int)

Parameters:

• name (str) – Name of event.

• onset (int) – Starting index of event (included).

• offset (int) – Ending index of event (excluded).

Examples

>>> event = Event(
...    name="custom_event",
...    onset=5,
...    offset=10,
... )
>>> print(event)
Event(name=custom_event, onset=5, offset=10)

Methods

__init__(name, onset, offset)

param name: Name of event.

Attributes

duration	Get sample duration of event.
schema