get_channel_map_and_networks

selfeeg.augmentation.functional.get_channel_map_and_networks(channel_map: list = None, chan_net: list[str] = 'all') → tuple[ArrayLike, list[ArrayLike]][source]

returns the channel_map and the chan_net arguments for permute_channels.

See the permute_channels help for more info.

Parameters:

  • channel_map (list, optional) –

    A list with all the EEG channel names, given as strings in upper case (e.g. “FP1”, “CZ”, “C1”). Channel names must refer to the 10-10 international system. If left to None, the following 61 channel map will be initialized:

    • [‘FP1’, ‘AF7’, ‘AF3’, ‘F1’, ‘F3’, ‘F5’, ‘F7’, ‘FT7’, ‘FC5’, ‘FC3’, ‘FC1’, ‘C1’, ‘C3’, ‘C5’, ‘T7’, ‘TP7’, ‘CP5’, ‘CP3’, ‘CP1’, ‘P1’, ‘P3’, ‘P5’, ‘P7’, ‘PO7’, ‘PO3’, ‘O1’, ‘OZ’, ‘POZ’, ‘PZ’, ‘CPZ’, ‘FPZ’, ‘FP2’, ‘AF8’, ‘AF4’, ‘AFZ’, ‘FZ’, ‘F2’, ‘F4’, ‘F6’, ‘F8’, ‘FT8’, ‘FC6’, ‘FC4’, ‘FC2’, ‘FCZ’, ‘CZ’, ‘C2’, ‘C4’, ‘C6’, ‘T8’, ‘TP8’, ‘CP6’, ‘CP4’, ‘CP2’, ‘P2’, ‘P4’, ‘P6’, ‘P8’, ‘PO8’, ‘PO4’, ‘O2’]

    Default = None

  • chan_net (list[str], optional) –

    A list of strings with the brain network acronyms. It will be used to select the subset of channels to permute between each other if permute_channels called in network mode.

    Default = ‘all’

Returns:

  • channel_map (ArrayLike) – The EEG Channel Map as a dtype “U4” numpy array.

  • chan_net (list[ArrayLike]) – A list with all the channels network to be used during the channel permutation.

Note

This function is internally called by permute_channels.