pymovements.events.events.Saccade#

class pymovements.events.events.Saccade(onset: int, offset: int)[source]#

Saccade 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__(onset: int, offset: int)[source]
Parameters:
  • onset (int) – Starting index of event (included).

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

Examples

>>> saccade = Saccade(
...    onset=8,
...    offset=10,
... )
>>> print(saccade)
Saccade(name=saccade, onset=8, offset=10)

Methods

__init__(onset, offset)

param onset:

Starting index of event (included).

Attributes

duration

Get sample duration of event.

schema