Skip to content

EEG Data Models

EEGCognitiveProfile

The EEG-specific cognitive profile, extending CognitiveProfile with EEG metadata.

EEGCognitiveProfile

Bases: CognitiveProfile

Cognitive profile derived from EEG data.

Extends :class:CognitiveProfile with EEG-specific metadata such as number of epochs, sampling rate, and channel count.

All TC scoring, gate evaluation, and band mapping are performed server-side. This model holds only the results.

Example::

profile = eeg.score(epochs)
print(profile.tc_score)       # 23.4
print(profile.n_epochs)       # 900
profile.radar_chart()

radar_chart(show=True, save=None, **kwargs)

Display 13-function EEG cognitive radar chart.

Requires: pip install aime-loc[viz]

summary()

One-line text summary.

EEGSession

Container for multi-subject / multi-task EEG studies.

EEGSession

Container for multi-subject / multi-task EEG studies.

Example::

session = eeg.session()
for f in Path("data/").glob("sub-*/eeg/*.set"):
    rec = eeg.load(f)
    rec.preprocess()
    session.add(rec, subject=f.parent.parent.name, task=f.stem)

results = eeg.score_session(session)

n_recordings property

subjects property

tasks property

add(epochs, *, subject=None, task=None)

Add an epoch set to the session.

Parameters:

Name Type Description Default
epochs EpochSet

Extracted PSD epochs from a recording.

required
subject str | None

Subject identifier.

None
task str | None

Task label.

None

get_entries()

Get all session entries.

SessionResults

Results from scoring an entire EEG session.

SessionResults

Results from scoring an entire EEG session.

Contains per-recording profiles and group-level statistics.

n_profiles property

summary_table()

Print a summary table of all profiles.

export_csv(path)

Export all profiles to CSV.