Skip to content

Fill in the EEG Conversion Configuration File

If you are using the ANC EEG conversion pipeline, your dataset project contains a file called .eeg_conversion_config.yml. This file tells the pipeline how to describe your EEG setup, map event codes to labels, and enrich the BIDS sidecar files.

Editing the file in GitLab

  1. Navigate to your dataset project on the ANC.
  2. In the file list, click .eeg_conversion_config.yml. You may need to enable Show hidden files to see it, as the filename starts with a dot.
  3. Click the Edit button (pencil icon) in the top right of the file view and select Edit single file.
  4. Make your changes directly in the editor.
  5. When done, scroll down, add a short commit message (e.g. Fill in EEG conversion config), and click Commit changes.

Filename convention

The pipeline parses subject, session, and task information from the EEG filename. Files must follow this format:

<group>_<project>_<subject>_<session>_<task>[_acq-<label>][_run-<number>].<edf|vhdr>
Component Description Example
group Research group identifier reachandtouch
project Your project slug — must match the top-level key in the config file a028
subject Participant identifier 001
session Session label 1
task Task name Hillyard
acq-<label> Acquisition label (optional) acq-long2partsbalanced
run-<number> Run number (optional) run-2

Example: reachandtouch_a028_001_1_Hillyard_acq-long2partsbalanced.vhdr

Task is mandatory in the filename

The task name must be part of the filename — it cannot be passed as a separate parameter.

What to fill in

Replace project_slug in the config with your actual project slug, then fill in the fields below. Only keep the fields relevant to your dataset — remove or comment out anything that does not apply.

Required

montage
The electrode layout used in your recording. Must be a montage name recognised by MNE-Python. Common values: standard_1020, standard_1005, easycap-M1, biosemi64.
EEGGround
Channel name of the ground electrode (e.g. GND, Fz, Fpz).
EEGReference
Reference electrode(s). Provide a single channel name or a list:
EEGReference: Cz              # single reference
EEGReference: [M1, M2]        # linked mastoids

Channel types

List the channel names for each non-EEG signal type present in your recording. Omit any row that does not apply.

Field Description Example
ecg Electrocardiogram [ECG1]
eog Electrooculogram [EOG1, EOG2]
veog Vertical EOG [VEOG]
heog Horizontal EOG [HEOG]
emg Electromyogram [EMG1]
resp Respiration [RESP]
stim Stimulus / marker channels [STI 014]
misc Miscellaneous [AUX1]
Full list of supported channel types

bio, chpi, csd, dbs, dipole, ecg, ecog, eeg, emg, eog, veog, heog, exci, eyegaze, fnirs_cw_amplitude, fnirs_fd_ac_amplitude, fnirs_fd_phase, fnirs_od, gof, gsr, hbo, hbr, ias, misc, pupil, ref_meg, resp, seeg, stim, syst, temperature

Events

events (required for event-related data)

Maps event codes or annotation strings to BIDS labels. Three formats are supported:

Format Example key Use case
Integer code 1 Simple numeric trigger
Range "10-19" Range of codes sharing the same label
Annotation string "Stimulus/S 3" BrainVision-style annotation markers

Each entry requires: - label — written to the trial_type column in events.tsv - type — either "stimulus" or "response"

Optional hardware and task metadata

These fields enrich the BIDS *_eeg.json sidecar. All are optional but recommended.

Field Description Example
Manufacturer EEG system manufacturer BrainVision
ManufacturersModelName Amplifier model BrainAmp
SoftwareVersions Acquisition software version "2.1"
CapManufacturer Electrode cap manufacturer EasyCap
CapManufacturersModelName Cap model M10
HardwareFilters Hardware filters applied "n/a"
SoftwareFilters Software filters applied "n/a"
EpochLength Epoch length in seconds 2.0
TaskDescription Free-text description of the task "Auditory oddball paradigm"
Instructions Instructions given to participants "Press the button when..."

Example — fully filled in

project_slug:
  montage: easycap-M1
  EEGGround: Fz
  EEGReference:
    - M1
    - M2

  ecg:
    - ECG1
  eog:
    - EOG1
    - EOG2
  emg:
    - EMG1
  resp:
    - RESP
  stim:
    - STI 014

  Manufacturer: BrainVision
  ManufacturersModelName: BrainAmp
  SoftwareVersions: "2.1"
  CapManufacturer: EasyCap
  CapManufacturersModelName: M10
  HardwareFilters: "n/a"
  SoftwareFilters: "n/a"
  TaskDescription: "Auditory oddball paradigm with standard and deviant tones"
  Instructions: "Press the button whenever you hear the deviant tone"

  events:
    1:
      label: "button_press"
      type: "response"
    "10-19":
      label: "stimulus_onset"
      type: "stimulus"
    "Stimulus/S  3":
      label: "trigger_3"
      type: "stimulus"