09-Task-Evaluate_Data/01d4_PRE_VIS_Fixation_Correction-it1.ipynb

{
 "cells": [
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Perform Fixation Correction Iteration 1\n",
    "Status: Implemented\n",
    " -- Fully automatized"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "collapsed": false,
    "jupyter": {
     "outputs_hidden": false
    }
   },
   "outputs": [],
   "source": [
    "import warnings\n",
    "\n",
    "import pandas as pd\n",
    "from tqdm.notebook import tqdm\n",
    "from utils.utils import *\n",
    "\n",
    "warnings.filterwarnings(\"ignore\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": false,
    "jupyter": {
     "outputs_hidden": false
    }
   },
   "outputs": [],
   "source": [
    "# get all files from participants\n",
    "folders = get_participant_folder_per_participant()\n",
    "sequence_orders = get_sequence_order_per_participant()\n",
    "assert (set(folders.keys()) == set(sequence_orders.keys()))\n",
    "snippets = {p: list(sequence_orders[p][SNIPPET].values)\n",
    "            for p in sequence_orders}"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Fixation correction iteration: 1\n",
      "Previous Fixation correction iteration: 0\n"
     ]
    }
   ],
   "source": [
    "global FIXATION_CORRECTION_ITERATION \n",
    "FIXATION_CORRECTION_ITERATION[0] = 1\n",
    "print('Fixation correction iteration:', current_fixation_correction_iteration())\n",
    "print('Previous Fixation correction iteration:', previous_fixation_correction_iteration())"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "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>Chars</th>\n",
       "      <th>EssentialChars</th>\n",
       "      <th>LoC</th>\n",
       "      <th>EssentialLoC</th>\n",
       "      <th>Max length LoC</th>\n",
       "      <th>Words</th>\n",
       "      <th>EssentialWords</th>\n",
       "      <th>CodeLines</th>\n",
       "      <th>EssentialCodeLines</th>\n",
       "      <th>number</th>\n",
       "      <th>version</th>\n",
       "      <th>Snippet_base</th>\n",
       "      <th>variant</th>\n",
       "      <th>Condition</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>Snippet</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>-clean-v0</th>\n",
       "      <td>49</td>\n",
       "      <td>33</td>\n",
       "      <td>3</td>\n",
       "      <td>3</td>\n",
       "      <td>26</td>\n",
       "      <td>16</td>\n",
       "      <td>10</td>\n",
       "      <td>['int V1 = 10;', 'int V2 = 3;', 'boolean R = (...</td>\n",
       "      <td>[1, 1, 1]</td>\n",
       "      <td>0</td>\n",
       "      <td>v0</td>\n",
       "      <td>--v0</td>\n",
       "      <td>clean</td>\n",
       "      <td>clean</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>-clean-v1</th>\n",
       "      <td>48</td>\n",
       "      <td>32</td>\n",
       "      <td>3</td>\n",
       "      <td>3</td>\n",
       "      <td>26</td>\n",
       "      <td>16</td>\n",
       "      <td>10</td>\n",
       "      <td>['int V1 = 4;', 'int V2 = 2;', 'boolean R = (V...</td>\n",
       "      <td>[1, 1, 1]</td>\n",
       "      <td>0</td>\n",
       "      <td>v1</td>\n",
       "      <td>--v1</td>\n",
       "      <td>clean</td>\n",
       "      <td>clean</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>-clean-v2</th>\n",
       "      <td>48</td>\n",
       "      <td>32</td>\n",
       "      <td>3</td>\n",
       "      <td>3</td>\n",
       "      <td>26</td>\n",
       "      <td>16</td>\n",
       "      <td>10</td>\n",
       "      <td>['int V1 = 1;', 'int V2 = 5;', 'boolean R = (V...</td>\n",
       "      <td>[1, 1, 1]</td>\n",
       "      <td>0</td>\n",
       "      <td>v2</td>\n",
       "      <td>--v2</td>\n",
       "      <td>clean</td>\n",
       "      <td>clean</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>-obf-v0</th>\n",
       "      <td>54</td>\n",
       "      <td>36</td>\n",
       "      <td>3</td>\n",
       "      <td>3</td>\n",
       "      <td>31</td>\n",
       "      <td>18</td>\n",
       "      <td>10</td>\n",
       "      <td>['int V1 = 10;', 'int V2 = 3;', 'boolean R = (...</td>\n",
       "      <td>[1, 1, 1]</td>\n",
       "      <td>0</td>\n",
       "      <td>v0</td>\n",
       "      <td>--v0</td>\n",
       "      <td>obf</td>\n",
       "      <td>confusing</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>-obf-v1</th>\n",
       "      <td>54</td>\n",
       "      <td>36</td>\n",
       "      <td>3</td>\n",
       "      <td>3</td>\n",
       "      <td>32</td>\n",
       "      <td>18</td>\n",
       "      <td>10</td>\n",
       "      <td>['int V1 = 4;', 'int V2 = 2;', 'boolean R = ( ...</td>\n",
       "      <td>[1, 1, 1]</td>\n",
       "      <td>0</td>\n",
       "      <td>v1</td>\n",
       "      <td>--v1</td>\n",
       "      <td>obf</td>\n",
       "      <td>confusing</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9-clean-v1</th>\n",
       "      <td>37</td>\n",
       "      <td>26</td>\n",
       "      <td>3</td>\n",
       "      <td>3</td>\n",
       "      <td>21</td>\n",
       "      <td>11</td>\n",
       "      <td>7</td>\n",
       "      <td>['int V1 = 5;', 'boolean R = (V1 &gt; 2);', 'V1--;']</td>\n",
       "      <td>[1, 1, 1]</td>\n",
       "      <td>9</td>\n",
       "      <td>v1</td>\n",
       "      <td>9--v1</td>\n",
       "      <td>clean</td>\n",
       "      <td>clean</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9-clean-v2</th>\n",
       "      <td>38</td>\n",
       "      <td>27</td>\n",
       "      <td>3</td>\n",
       "      <td>3</td>\n",
       "      <td>22</td>\n",
       "      <td>11</td>\n",
       "      <td>7</td>\n",
       "      <td>['int V1 = 8;', 'boolean R = (V1 &lt;= 7);', 'V1-...</td>\n",
       "      <td>[1, 1, 1]</td>\n",
       "      <td>9</td>\n",
       "      <td>v2</td>\n",
       "      <td>9--v2</td>\n",
       "      <td>clean</td>\n",
       "      <td>clean</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9-obf-v0</th>\n",
       "      <td>35</td>\n",
       "      <td>25</td>\n",
       "      <td>2</td>\n",
       "      <td>2</td>\n",
       "      <td>24</td>\n",
       "      <td>10</td>\n",
       "      <td>6</td>\n",
       "      <td>['int V1 = 2;', 'boolean R = (V1-- == 1);']</td>\n",
       "      <td>[1, 1]</td>\n",
       "      <td>9</td>\n",
       "      <td>v0</td>\n",
       "      <td>9--v0</td>\n",
       "      <td>obf</td>\n",
       "      <td>confusing</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9-obf-v1</th>\n",
       "      <td>34</td>\n",
       "      <td>24</td>\n",
       "      <td>2</td>\n",
       "      <td>2</td>\n",
       "      <td>23</td>\n",
       "      <td>10</td>\n",
       "      <td>6</td>\n",
       "      <td>['int V1 = 5;', 'boolean R = (V1-- &gt; 2);']</td>\n",
       "      <td>[1, 1]</td>\n",
       "      <td>9</td>\n",
       "      <td>v1</td>\n",
       "      <td>9--v1</td>\n",
       "      <td>obf</td>\n",
       "      <td>confusing</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9-obf-v2</th>\n",
       "      <td>35</td>\n",
       "      <td>25</td>\n",
       "      <td>2</td>\n",
       "      <td>2</td>\n",
       "      <td>24</td>\n",
       "      <td>10</td>\n",
       "      <td>6</td>\n",
       "      <td>['int V1 = 8;', 'boolean R = (V1-- &lt;= 7);']</td>\n",
       "      <td>[1, 1]</td>\n",
       "      <td>9</td>\n",
       "      <td>v2</td>\n",
       "      <td>9--v2</td>\n",
       "      <td>obf</td>\n",
       "      <td>confusing</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>144 rows × 14 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "            Chars  EssentialChars  LoC  EssentialLoC  Max length LoC  Words   \n",
       "Snippet                                                                       \n",
       "-clean-v0      49              33    3             3              26     16  \\\n",
       "-clean-v1      48              32    3             3              26     16   \n",
       "-clean-v2      48              32    3             3              26     16   \n",
       "-obf-v0        54              36    3             3              31     18   \n",
       "-obf-v1        54              36    3             3              32     18   \n",
       "...           ...             ...  ...           ...             ...    ...   \n",
       "9-clean-v1     37              26    3             3              21     11   \n",
       "9-clean-v2     38              27    3             3              22     11   \n",
       "9-obf-v0       35              25    2             2              24     10   \n",
       "9-obf-v1       34              24    2             2              23     10   \n",
       "9-obf-v2       35              25    2             2              24     10   \n",
       "\n",
       "            EssentialWords                                          CodeLines   \n",
       "Snippet                                                                         \n",
       "-clean-v0               10  ['int V1 = 10;', 'int V2 = 3;', 'boolean R = (...  \\\n",
       "-clean-v1               10  ['int V1 = 4;', 'int V2 = 2;', 'boolean R = (V...   \n",
       "-clean-v2               10  ['int V1 = 1;', 'int V2 = 5;', 'boolean R = (V...   \n",
       "-obf-v0                 10  ['int V1 = 10;', 'int V2 = 3;', 'boolean R = (...   \n",
       "-obf-v1                 10  ['int V1 = 4;', 'int V2 = 2;', 'boolean R = ( ...   \n",
       "...                    ...                                                ...   \n",
       "9-clean-v1               7  ['int V1 = 5;', 'boolean R = (V1 > 2);', 'V1--;']   \n",
       "9-clean-v2               7  ['int V1 = 8;', 'boolean R = (V1 <= 7);', 'V1-...   \n",
       "9-obf-v0                 6        ['int V1 = 2;', 'boolean R = (V1-- == 1);']   \n",
       "9-obf-v1                 6         ['int V1 = 5;', 'boolean R = (V1-- > 2);']   \n",
       "9-obf-v2                 6        ['int V1 = 8;', 'boolean R = (V1-- <= 7);']   \n",
       "\n",
       "           EssentialCodeLines  number version Snippet_base variant  Condition  \n",
       "Snippet                                                                        \n",
       "-clean-v0           [1, 1, 1]       0      v0         --v0   clean      clean  \n",
       "-clean-v1           [1, 1, 1]       0      v1         --v1   clean      clean  \n",
       "-clean-v2           [1, 1, 1]       0      v2         --v2   clean      clean  \n",
       "-obf-v0             [1, 1, 1]       0      v0         --v0     obf  confusing  \n",
       "-obf-v1             [1, 1, 1]       0      v1         --v1     obf  confusing  \n",
       "...                       ...     ...     ...          ...     ...        ...  \n",
       "9-clean-v1          [1, 1, 1]       9      v1        9--v1   clean      clean  \n",
       "9-clean-v2          [1, 1, 1]       9      v2        9--v2   clean      clean  \n",
       "9-obf-v0               [1, 1]       9      v0        9--v0     obf  confusing  \n",
       "9-obf-v1               [1, 1]       9      v1        9--v1     obf  confusing  \n",
       "9-obf-v2               [1, 1]       9      v2        9--v2     obf  confusing  \n",
       "\n",
       "[144 rows x 14 columns]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "code_sizes = pd.read_csv(CODE_SIZE_PATH, sep=SEPARATOR,\n",
    "                         index_col=False).set_index(SNIPPET)\n",
    "display(code_sizes)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Take into account previous iteration of manual evaluation"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "# check whether there already exist manual evaluation files\n",
    "manual_evaluation_paths = exist_previous_manual_accuracy_evaluation_paths()\n",
    "if manual_evaluation_paths and current_fixation_correction_iteration() > 1:\n",
    "    assert (set(folders.keys()) == set(manual_evaluation_paths.keys())), f'''folder: {folders.keys()}, \\neval paths: {manual_evaluation_paths.keys()}'''\n",
    "\n",
    "    print('There exist manual accuracy evaluation files from the previous iteration which will be considered for this iteration\\'s fixation correction. ')\n",
    "    print(manual_evaluation_paths)\n",
    "    for participant in manual_evaluation_paths:\n",
    "        print('----------------------------------------------')\n",
    "        print(PARTICIPANT, participant)\n",
    "\n",
    "        print('(01/04) Load accuracy evaluation file')\n",
    "        manual_evaluation = pd.read_csv(\n",
    "            manual_evaluation_paths[participant], sep=SEPARATOR, index_col=False, dtype={PARTICIPANT: str})\n",
    "\n",
    "        print('(02/04) Select those in need of rework')\n",
    "        to_rework = get_to_rework_manual_accuracy_evaluation(\n",
    "            manual_evaluation, participant, snippets[participant])\n",
    "\n",
    "        print('(03/04) Check that outliers were removed correctly and offsets were adapted')\n",
    "        check_outlier_offset_actions(to_rework, participant)\n",
    "\n",
    "        print('(04/04) Save snippets to rework')\n",
    "        # save snippet names to rework in file\n",
    "        to_rework[SNIPPET].to_csv(get_snippet_rework_paths(\n",
    "            participant), sep=SEPARATOR, index=False)\n",
    "        snippets[participant] = to_rework[SNIPPET].to_list()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Auto-correction\n",
    "* perform auto-correction with various algorithms"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "if current_fixation_correction_iteration() > 1:\n",
    "    # Iterate over all participants\n",
    "    for participant in tqdm(folders):\n",
    "        print('----------------------------------------------')\n",
    "        print(PARTICIPANT, participant)\n",
    "        if not snippets[participant]:\n",
    "            print('no snippets to (re-)work found.')\n",
    "            continue\n",
    "\n",
    "        print('(01/04) Delete existing fixation corrections')\n",
    "        for snippet in tqdm(snippets[participant]):\n",
    "            fixation_correction_paths = get_all_fixation_correction_paths(\n",
    "                participant, snippet)\n",
    "            for p in fixation_correction_paths:\n",
    "                p.unlink()\n",
    "\n",
    "        print('(02/04) Retrieve fixation data')\n",
    "        participant_snippet_fixations = {}\n",
    "        not_available = set()\n",
    "        for snippet in tqdm(snippets[participant]):\n",
    "            snippet_fixations_path = get_fixations_path(\n",
    "                participant, snippet, no_outliers_if_exists=True, iteration=previous_fixation_correction_iteration)\n",
    "            if snippet_fixations_path.exists():\n",
    "                participant_snippet_fixations[snippet] = pd.read_csv(\n",
    "                    snippet_fixations_path, index_col=False, sep=SEPARATOR, dtype={PARTICIPANT: str})\n",
    "                participant_snippet_fixations[snippet].to_csv(get_fixations_path(\n",
    "                    participant, snippet, no_outliers_if_exists=False), index=False, sep=SEPARATOR)\n",
    "            else:\n",
    "                not_available.add(snippet)\n",
    "        if not_available:\n",
    "            update_exclusions(participant, SNIPPET, VISUAL, {snippet: f'''01d4_PRE_VIS_Fixation_Correction-it{\n",
    "                              current_fixation_correction_iteration()}: Fixation data not available''' for snippet in not_available})\n",
    "        for snippet in not_available:\n",
    "            snippets[participant].remove(snippet)\n",
    "\n",
    "        print('(03/04) Perform auto-correction')\n",
    "        corrected_snippet_fixations = calculate_corrected_fixations(\n",
    "            participant_snippet_fixations, code_sizes)\n",
    "\n",
    "        print('(04/04) Store corrected fixation data')\n",
    "        # save fixation data\n",
    "        for snippet in tqdm(corrected_snippet_fixations):\n",
    "            corrected_fixation_datasets = corrected_snippet_fixations[snippet]\n",
    "            for key, fixation_data in corrected_fixation_datasets.items():\n",
    "                if key == FIXATION_CORRECTION_ALGORITHM_ORIGINAL:\n",
    "                    continue\n",
    "                fixation_data.to_csv(get_fixations_path(\n",
    "                    participant, snippet, modified_version=key), index=False, sep=SEPARATOR)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "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.11.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}