obob_mne.mixins.raw.AdvancedEvents

class obob_mne.mixins.raw.AdvancedEvents(*args, **kwargs)[source]

Integrate event loading and handling into mne.io.Raw.

Including this mixin in your study specific Raw class provides event handling features directly in that class.

More specifically, it provides three extra properties:

  1. events
  2. event_id
  3. evt_metadata

Which are automatically filled and kept up-to-date. They correspond to the respective meaning in mne.Epochs.

You can also create a subclass of this class and use _process_events() to process the events (fill the event_id, modify the event codes….)

event_id

The event_ids

Type:dict
events

The event matrix.

Type:numpy.ndarray
evt_metadata

The metadata

Type:pandas.DataFrame
get_filtered_event_id(condition_filter)[source]

Return a filtered version of the event_id field.

Refer to obob_mne.events.filter_event_id() for further details.

has_filtered_events(condition_filter)[source]

Check whether the event_ids are present.

Parameters:condition_filter (str) – The event_ids to check
Returns:has_events – True if the filtered events are present.
Return type:bool
resample(*args, **kwargs)[source]

Resample the data and reloads the events.

For the rest, refer to mne.io.Raw.resample().