Skip to content

ENH: Read and store "START" and "END" events from EDF file #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 11, 2025
Merged

ENH: Read and store "START" and "END" events from EDF file #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b5e011
ENH: Read and store "START" and "END" events from EDF file
scott-huberty Feb 5, 2025
676f0a8
TST: add a unit test for start and end events
scott-huberty Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions src/eyelinkio/edf/read.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ def __exit__(self, type_, value, traceback):
BUTTONEVENT="buttons",
INPUTEVENT="inputs",
MESSAGEEVENT="messages",
STARTEVENTS="starts",
ENDEVENTS="ends",
)


Expand Down Expand Up @@ -209,7 +211,16 @@ def _read_raw_edf(fname):
#
discrete = res["discrete"]
info = res["info"]
event_types = ("saccades", "fixations", "blinks", "buttons", "inputs", "messages")
event_types = (
"saccades",
"fixations",
"blinks",
"buttons",
"inputs",
"messages",
"starts",
"ends",
)
info["sample_fields"] = info["sample_fields"][1:] # omit time

#
Expand Down Expand Up @@ -541,6 +552,10 @@ def _handle_end(edf, res, name):
f = ["sttime", "buttons"]
elif name == "inputs":
f = ["sttime", "input"]
elif name == "starts":
f = ["sttime"]
elif name == "ends":
f = ["sttime"]
else:
raise KeyError(f"Unknown name {name}")
res["edf_fields"][name] = f
Expand Down Expand Up @@ -592,7 +607,7 @@ def _handle_version(res):
BREAKPARSE=_handle_pass,
STARTSAMPLES=_handle_pass,
ENDSAMPLES=_handle_pass,
STARTEVENTS=_handle_pass,
ENDEVENTS=_handle_pass,
STARTEVENTS=partial(_handle_end, name="starts"),
ENDEVENTS=partial(_handle_end, name="ends"),
VERSION=_handle_version,
)
4 changes: 4 additions & 0 deletions src/eyelinkio/tests/test_edf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ def test_read_raw():
# XXX: ideally we should get a binocular file with a calibration
assert edf_file["info"]["eye"] == "BINOCULAR"
assert len(edf_file["discrete"]["blinks"]) == 195
np.testing.assert_equal(edf_file["discrete"]["starts"]["stime"][0], 0.0)
np.testing.assert_almost_equal(
edf_file["discrete"]["ends"]["stime"][-1], 199.644
)

elif fname.name == "test_2_raw.edf": # First test file has this property
for kind in ['saccades', 'fixations', 'blinks']:
Expand Down