edfio.Recording#

class edfio.Recording(*, startdate=None, hospital_administration_code='X', investigator_technician_code='X', equipment_code='X', additional=())[source]#

Object representation of the local recording identification.

Parsing from/to the string containing the local_recording_identification header field is done according to the EDF+ specs. Subfields must be ASCII (32..126) and may not contain spaces.

Parameters:
startdatedatetime.date | None, default: None

The recording startdate.

hospital_administration_codestr, default: "X"

The hospital administration code of the investigation, e.g., EEG number or PSG number.

investigator_technician_codestr, default: "X"

A code specifying the responsible investigator or technician.

equipment_codestr, default: "X"

A code specifying the used equipment.

additionalSequence[str], default: ()

Optional additional subfields. Will be stored in the header field separated by spaces.

Attributes

additional

Optional additional subfields.

equipment_code

A code specifying the used equipment.

hospital_administration_code

The hospital administration code of the investigation.

investigator_technician_code

A code specifying the responsible investigator or technician.

startdate

The recording startdate.

Methods

__init__

get_subfield

Access a subfield of the local recording identification field by index.

property additional[source]#

Optional additional subfields.

property equipment_code[source]#

A code specifying the used equipment.

get_subfield(idx)[source]#

Access a subfield of the local recording identification field by index.

Parameters:
idxint

The index of the subfield to access. The first subfield (starting at index 0) should always be “Startdate” according to the EDF+ spedification.

Returns:
str

The subfield at the specified index. If the index exceeds the actually available number of subfields, the return value is "X".

property hospital_administration_code[source]#

The hospital administration code of the investigation.

property investigator_technician_code[source]#

A code specifying the responsible investigator or technician.

property startdate[source]#

The recording startdate.