micromed_io.header.MicromedHeader

class micromed_io.header.MicromedHeader(surname: str | None = None, name: str | None = None, nb_of_channels: int | None = None, order: list | None = None, acq_unit: int | None = None, min_sampling_rate: int | None = None, nb_of_bytes: int | None = None, header_type: int | None = None, stored_channels: int | None = None, ch_names: list | None = None, elec_refs: list | None = None, data_address: int | None = None, recording_date: datetime | None = None, notes: dict | None = None, markers: dict | None = None)

Bases: object

Micromed Header data

The header is common between TRC files and TCP communication. It contains the info to decode the data correctly and some experiment info.

This class extract some of the available info.

Parameters:

surnamestr, optional

The patient surname.

namestr, optional

The patient name.

nb_of_channelsint, optional

The number of channels.

acq_unitint, optional

The acquisition unit

min_sampling_rate: int, optional

The minimum sampling rate of EEGs channels.

nb_of_bytes: int, optional

The number of bytes on which eeg data is encoded per value. Should be in [1, 2, 4].

Warning

When selecting a 24-bits resolution in SystemPLUS, values are encoded on 4 bytes…

header_type: int, optional

The header type. To be checked for valid parsing.

stored_channels: int, optional

Number of stored channels in EEGs data.

ch_names: list, optional

The channel names in format “<ch name>-<ground>”.

elec_refs: List[ElectrodeReferences], optional

A list of electrode references.

data_address: int, optional

The byte address of data packet start (useless in TCP context)

note_addressint, optional

The byte address of note packet start (useless in TCP context)

Attributes:

surnamestr

The patient surname.

namestr

The patient name.

nb_of_channelsint

The number of channels.

acq_unitint, optional

The acquisition unit

min_sampling_rate: int

The minimum sampling rate of EEGs channels.

nb_of_bytes: int

The number of bytes on which eeg data is encoded per value. Should be in [1, 2, 4].

Warning

When selecting a 24-bits resolution in SystemPLUS, values are encoded on 4 bytes…

header_type: int

The header type. To be checked for valid parsing.

stored_channels: int

Number of stored channels in EEGs data.

ch_names: list

The channel names in format “<ch name>-<ground>”.

elec_refs: List[ElectrodeReferences]

A list of electrode references.

data_address: int

The byte address of data packet start (useless in TCP context).

note_addressint

The byte address of note packet start (useless in TCP context)

recording_date: datetime

The date of file creation and therefore the recording date.

notesdict

Notes entered in Micromed interface. Keys are samples and values are comments (str).

markersdict

Serial markers received by Micromed. Key is the sample and value is the marker value (str).

Methods

Attributes detail

acq_unit
ch_names
data_address
elec_refs
header_type
markers
min_sampling_rate
name
nb_of_bytes
nb_of_channels
notes
order
recording_date
stored_channels
surname