Use Annotations for read_raw_egi events #12300
Conversation
| @@ -103,6 +103,7 @@ def read_raw_egi( | |||
| exclude=None, | |||
| preload=False, | |||
| channel_naming="E%d", | |||
| events_as_annotations=False, | |||
There was a problem hiding this comment.
| events_as_annotations=False, | |
| *, | |
| events_as_annotations=False, |
| events_as_annotations : bool | ||
| If True, annotations are created from experiment events. If False (default), | ||
| synthetic trigger channels are created from experiment events. See the Notes | ||
| section for details. | ||
|
|
||
| .. versionadded:: 0.14.0 |
There was a problem hiding this comment.
| events_as_annotations : bool | |
| If True, annotations are created from experiment events. If False (default), | |
| synthetic trigger channels are created from experiment events. See the Notes | |
| section for details. | |
| .. versionadded:: 0.14.0 | |
| .. versionadded:: 0.14.0 | |
| events_as_annotations : bool | |
| If True, annotations are created from experiment events. If False (default), | |
| synthetic trigger channels are created from experiment events. See the Notes | |
| section for details. | |
| .. versionadded:: 1.7.0 |
| annot["onset"].extend(ev[:, 0] / self.info["sfreq"]) | ||
| annot["duration"].extend(np.zeros(ev.shape[0])) | ||
| annot["description"].extend([event_dict[e] for e in ev[:, 2]]) | ||
| self.set_annotations(Annotations(**annot)) |
There was a problem hiding this comment.
I would go a step further and when events_as_annotations=True is used, do not create the synthetic event channel and raw.event_id
There was a problem hiding this comment.
Sure, since those synthetic channels are already created by the time it reaches my code, I can delete them if events_as_annotations is true
There was a problem hiding this comment.
Rather than create then delete, would be better to avoid creation in the first place
There was a problem hiding this comment.
Hmm ok. Then i'll need to take a new approach to this PR! Since now I am just using mne.find_eventsand convert those events to annotations.
| # Grab the first annotation. Should be the first "DIN1" event. | ||
| assert len(raw.annotations) | ||
| onset, dur, desc, _ = raw.annotations[0].values() | ||
| assert np.isclose(onset, 2.438) |
There was a problem hiding this comment.
Use this instead, the error is more informative
| assert np.isclose(onset, 2.438) | |
| assert_allclose(onset, 2.438) |
As suggested here I can quickly check if simply allowing the initial one-shot event fixes the issue without breaking a bunch of tests. If it ends up being more complicated than that, maybe it will be a better use of time instead to get a PR up that uses mffpy which should solve those issues, as suggested here I can report back. |
Closes #12262
adds a parameter
events_as_annotations(default False for backward compat), which will create annotations from EGI events.@larsoner what do you think of this design and the new parameter name?