pymovements.events.EventDataFrame#

class pymovements.events.EventDataFrame(data: pl.DataFrame | None = None, name: str | list[str] | None = None, onsets: list[int] | np.ndarray | None = None, offsets: list[int] | np.ndarray | None = None)[source]#

A DataFrame for event data.

Each row has at least an event name with its onset and offset specified.

Parameters:

  • data (pl.DataFrame | None) – A dataframe to be transformed to a polars dataframe. This argument is mutually exclusive with all the other arguments. (default: None)

  • name (str | list[str] | None) – Name of events. (default: None)

  • onsets (list[int] | np.ndarray | None) – List of onsets. (default: None)

  • offsets (list[int] | np.ndarray | None) – List of offsets. (default: None)

Raises:

ValueError – If list of onsets is passed but not a list of offsets, or vice versa, or if length of onsets does not match length of offsets.

__init__(data: pl.DataFrame | None = None, name: str | list[str] | None = None, onsets: list[int] | np.ndarray | None = None, offsets: list[int] | np.ndarray | None = None)[source]

Methods

__init__([data, name, onsets, offsets])

add_event_properties(event_properties, join_on)

Add new event properties into dataframe.

copy()

Return a copy of the EventDataFrame.

Attributes

columns

List of column names.

event_property_columns

Event property columns for this dataframe.

schema

Schema of event dataframe.