pymovements.events.events.Fixation#

class pymovements.events.events.Fixation(onset: int, offset: int, position: tuple[float, float])[source]#

Fixation class.

name#

Name of event.

Type:

str

onset#

Starting index of event (included).

Type:

int

offset#

Ending index of event (excluded).

Type:

int

position#

(x, y) position of fixation

Type:

tuple[float, float]

schema#

Schema for event DataFrame.

Type:

polars.SchemaDict

__init__(onset: int, offset: int, position: tuple[float, float])[source]
Parameters:
  • onset (int) – Starting index of event (included).

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

  • position (tuple[float, float]) – (x, y) position of fixation

Examples

>>> fixation = Fixation(
...    onset=5,
...    offset=10,
...    position=(125.1, 852.3),
... )
>>> print(fixation)
Fixation(name=fixation, onset=5, offset=10, position=(125.1, 852.3))

Methods

__init__(onset, offset, position)

param onset:

Starting index of event (included).

Attributes

duration

Get sample duration of event.

schema