{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "e59edc53-073e-4d94-9599-01b613ef2201",
   "metadata": {},
   "source": [
    "# Utils"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "c80a4d05-68fa-4100-9ca2-ad4575c5f6a5",
   "metadata": {},
   "source": [
    "## Best montage\n",
    "The function ´get_best_montage´ return a list with all compatible MNE montages."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "id": "40d7f7f2-4992-4f67-beaa-633a1f0e08ff",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>count</th>\n",
       "      <th>missings</th>\n",
       "      <th>missings channels</th>\n",
       "      <th>montage</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>64</td>\n",
       "      <td>0</td>\n",
       "      <td>[]</td>\n",
       "      <td>standard_1020</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>64</td>\n",
       "      <td>0</td>\n",
       "      <td>[]</td>\n",
       "      <td>standard_1005</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>62</td>\n",
       "      <td>2</td>\n",
       "      <td>[T10, T9]</td>\n",
       "      <td>easycap-M1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>62</td>\n",
       "      <td>2</td>\n",
       "      <td>[T10, T9]</td>\n",
       "      <td>biosemi64</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>36</td>\n",
       "      <td>28</td>\n",
       "      <td>[Af8, Fc3, P7, Fc1, Cp5, Cp3, Fcz, T7, Cpz, T8...</td>\n",
       "      <td>standard_prefixed</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>32</td>\n",
       "      <td>32</td>\n",
       "      <td>[Af8, Poz, P2, Fc3, Cp3, Fcz, Cpz, Cp4, C2, C1...</td>\n",
       "      <td>biosemi32</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>30</td>\n",
       "      <td>34</td>\n",
       "      <td>[Af8, Poz, Fc3, P7, Fc1, Cp5, Cp3, Fcz, T7, Cp...</td>\n",
       "      <td>standard_primed</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>30</td>\n",
       "      <td>34</td>\n",
       "      <td>[Af8, Poz, Fc3, P7, Fc1, Cp5, Cp3, Fcz, T7, Cp...</td>\n",
       "      <td>standard_postfixed</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>29</td>\n",
       "      <td>35</td>\n",
       "      <td>[Af8, Poz, Fc3, P7, Fc1, Cp5, Cp3, Fcz, T7, Cp...</td>\n",
       "      <td>standard_alphabetic</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>16</td>\n",
       "      <td>48</td>\n",
       "      <td>[Af8, Poz, P2, Fc3, P7, Fc1, Cp5, Cp3, Fcz, Cp...</td>\n",
       "      <td>biosemi16</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>10</th>\n",
       "      <td>14</td>\n",
       "      <td>50</td>\n",
       "      <td>[Af8, Oz, Poz, P2, Fc3, P7, Fc1, Cp5, Cp3, Fcz...</td>\n",
       "      <td>biosemi256</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>11</th>\n",
       "      <td>6</td>\n",
       "      <td>58</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>biosemi128</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>12</th>\n",
       "      <td>6</td>\n",
       "      <td>58</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>biosemi160</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>13</th>\n",
       "      <td>1</td>\n",
       "      <td>63</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>GSN-HydroCel-257</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>14</th>\n",
       "      <td>1</td>\n",
       "      <td>63</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>GSN-HydroCel-32</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>15</th>\n",
       "      <td>1</td>\n",
       "      <td>63</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>GSN-HydroCel-65_1.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>16</th>\n",
       "      <td>1</td>\n",
       "      <td>63</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>GSN-HydroCel-129</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>17</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Oz, P2, F4, Fc1, Cp5, T7, F3, P4, P3, P6, Afz...</td>\n",
       "      <td>artinis-octamon</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>18</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>EGI_256</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>19</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>mgh70</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>20</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>mgh60</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>21</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>easycap-M10</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>22</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>GSN-HydroCel-128</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>23</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>GSN-HydroCel-64_1.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>GSN-HydroCel-256</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>25</th>\n",
       "      <td>0</td>\n",
       "      <td>64</td>\n",
       "      <td>[Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...</td>\n",
       "      <td>artinis-brite23</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "    count  missings                                  missings channels  \\\n",
       "0      64         0                                                 []   \n",
       "1      64         0                                                 []   \n",
       "2      62         2                                          [T10, T9]   \n",
       "3      62         2                                          [T10, T9]   \n",
       "4      36        28  [Af8, Fc3, P7, Fc1, Cp5, Cp3, Fcz, T7, Cpz, T8...   \n",
       "5      32        32  [Af8, Poz, P2, Fc3, Cp3, Fcz, Cpz, Cp4, C2, C1...   \n",
       "6      30        34  [Af8, Poz, Fc3, P7, Fc1, Cp5, Cp3, Fcz, T7, Cp...   \n",
       "7      30        34  [Af8, Poz, Fc3, P7, Fc1, Cp5, Cp3, Fcz, T7, Cp...   \n",
       "8      29        35  [Af8, Poz, Fc3, P7, Fc1, Cp5, Cp3, Fcz, T7, Cp...   \n",
       "9      16        48  [Af8, Poz, P2, Fc3, P7, Fc1, Cp5, Cp3, Fcz, Cp...   \n",
       "10     14        50  [Af8, Oz, Poz, P2, Fc3, P7, Fc1, Cp5, Cp3, Fcz...   \n",
       "11      6        58  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "12      6        58  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "13      1        63  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "14      1        63  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "15      1        63  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "16      1        63  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "17      0        64  [Oz, P2, F4, Fc1, Cp5, T7, F3, P4, P3, P6, Afz...   \n",
       "18      0        64  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "19      0        64  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "20      0        64  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "21      0        64  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "22      0        64  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "23      0        64  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "24      0        64  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "25      0        64  [Af8, Oz, Poz, P2, F4, Fc3, P7, Fc1, Cp5, Cp3,...   \n",
       "\n",
       "                montage  \n",
       "0         standard_1020  \n",
       "1         standard_1005  \n",
       "2            easycap-M1  \n",
       "3             biosemi64  \n",
       "4     standard_prefixed  \n",
       "5             biosemi32  \n",
       "6       standard_primed  \n",
       "7    standard_postfixed  \n",
       "8   standard_alphabetic  \n",
       "9             biosemi16  \n",
       "10           biosemi256  \n",
       "11           biosemi128  \n",
       "12           biosemi160  \n",
       "13     GSN-HydroCel-257  \n",
       "14      GSN-HydroCel-32  \n",
       "15  GSN-HydroCel-65_1.0  \n",
       "16     GSN-HydroCel-129  \n",
       "17      artinis-octamon  \n",
       "18              EGI_256  \n",
       "19                mgh70  \n",
       "20                mgh60  \n",
       "21          easycap-M10  \n",
       "22     GSN-HydroCel-128  \n",
       "23  GSN-HydroCel-64_1.0  \n",
       "24     GSN-HydroCel-256  \n",
       "25      artinis-brite23  "
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from gcpds.utils.mne_handler import get_best_montage\n",
    "\n",
    "names = ['fC5', 'Fc3', 'Fc1', 'Fcz', 'Fc2', 'Fc4', 'Fc6', 'C5', 'C3', 'C1', 'Cz', 'C2', 'C4', 'C6', 'Cp5', 'Cp3', 'Cp1', 'Cpz', 'Cp2', 'Cp4', 'Cp6', 'Fp1', 'Fpz', 'Fp2', 'Af7', 'Af3', 'Afz', 'Af4', 'Af8', 'F7', 'F5', 'F3', 'F1', 'Fz', 'F2', 'F4', 'F6', 'F8', 'Ft7', 'Ft8', 'T7', 'T8', 'T9', 'T10', 'Tp7', 'Tp8', 'P7', 'P5', 'P3', 'P1', 'Pz', 'P2', 'P4', 'P6', 'P8', 'Po7', 'Po3', 'Poz', 'Po4', 'Po8', 'O1', 'Oz', 'O2', 'Iz']\n",
    "get_best_montage(names)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.6"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}