edfio.read_edf

edfio.read_edf(edf_file, lazy_load_data='auto', *, header_encoding='ascii')

Read an EDF file into an Edf object.

If a file-like object is passed, its stream position is moved to EOF.

Parameters:

edf_filePath | str | io.BufferedReader | io.BytesIO

The file location (path object or string) or file-like object to read from.

lazy_load_databool | {“auto”}, default: “auto”

If True, the raw signal data is not loaded into memory until it is accessed. If False, the data is loaded immediately. If "auto", the data is loaded lazily if the specified edf_file represents a local path and the extension is not “.bdf” and eagerly otherwise.

header_encodingstr, default: “ascii”

The character encoding to use when reading header fields.

Returns:

Edf

The resulting Edf object.