Formatting Channel Names and Inspecting Metadata#

This tutorial shows how to load a dataset, inspect locator metadata, and standardize channel names.

Requirements#

  • EEGUnity installed

  • A CSV editor (optional) for manual locator inspection

Step 1: Load the Dataset#

from eegunity import UnifiedDataset

input_path = r"path/to/dataset"
ud = UnifiedDataset(dataset_path=input_path, domain_tag="my_dataset")

Step 2: Save the Initial Locator#

ud.save_locator(r"./locator/my_dataset_raw.csv")

Example locator preview:

Locator Example

Step 3: Keep Completed Records#

ud.eeg_batch.sample_filter(completeness_check="Completed")
ud.save_locator(r"./locator/my_dataset_completed.csv")

Example filtered locator preview:

Locator Example

Step 4: Format Channel Names#

ud.eeg_batch.format_channel_names()
ud.save_locator(r"./locator/my_dataset_format_channel_name.csv")

Example formatted locator preview:

Locator Example

After formatting, channel names should follow <Type>:<Name>, such as eeg:Fz or eog:LOC.

Step 5: Manual Correction (Optional)#

Open my_dataset_format_channel_name.csv and adjust any known metadata issues.

Step 6: Reload from Locator#

ud = UnifiedDataset(locator_path=r"./locator/my_dataset_format_channel_name.csv")

When loading from a locator, EEGUnity uses locator metadata as the source of truth.