----------------------------------------------------------------------
SECTION: Files Included
----------------------------------------------------------------------
IMAGES:
1. a1.jpg: sample image with dimensions: 1920x1080
2. money1.jpg: sample image with dimensions: 1280x800

PREPROCESSING SCRIPTS
3. fullDisp.m: function to display images on full resolution on any monitor. Is called in 'ImageStack.m'
4. getRadii.m: function that returns the radii of the blurs. Is called in 'ImageStack.m'. Need to modify 'screen_size', 'screen_resolution' and 'viewing_distance' according to experiment setup.
5. maskNBlur.m: function to perform gaussian blurring based on foveal-middle-peripheral strategy. Is called in 'ImageStack.m'. Need to modify 'IMAGE_PATH', 'sigma', 'm' according to experiment setup.
6. ImageStack.m: run this file to generate blurred images that are to be used for rendering.
7. ./downSampling/*.m: files not currently incorporated in experiment run. Can modify function calls in 'ImageStack.m' to incorporate. Perform blurring by downsampling by said downsampling factor and resize image to original dimensions.

RENDERING
8. runMe.py: execute to conduct experiment after pre-processing is complete. Includes comprehensive comments.

LIBRARY
9. peyetribe.py: provides functions to link and access information from the eyetribe eyetracker
10. pptetcalib.py: utils file containing supporting functions for 'peyetribe.py'


----------------------------------------------------------------------
SECTION: Executing instructions
----------------------------------------------------------------------
1. The developers recommend reading through the associated report and the readme section 'Files included' to understand the overall experimental setup and to make sure all variable are setup correctly to execute smoothly.
2. Run ImageStack.m to create and save blurred images inside the directory './stack'
	- Requires MATLAB to run
	- Save the centres.mat  and stack_mask.mat variables generated from the run
3. Connect EyeTribe Eyetracker to your machine and run the './EyeTribe/EyeTribe' executable file to establish link to the eyetracker.
4. Execute './EyeTribe/EyeTribeUI' and follow on-screen instructions to calibrate the eye tracker
5. Make sure the eyetracker is connected and reporting gaze coordinates, then execute 'runMe.py'
6. Once the rendering begins, press and key (except ESC) to toggle between the 'original image eye tracking' mode and 'foveated blur' mode.
7. Press ESC key to close the environment and the link to the tracker


----------------------------------------------------------------------
SECTION: Third-Party Softwares Used
----------------------------------------------------------------------

1.
=========
The Eye Tribe, ApS THIRD PARTY SOFTWARE 
=========
Details included in './EyeTribe/third-party-license.txt'

2.
=========
peyetribe
=========

Simple python interface to the Eye Tribe eye tracker (http://theeyetribe.com)

Created by Per Baekgaard / pgba@dtu.dk / baekgaard@b4net.dk, March 2014

Licensed under the MIT License:

Copyright (c) 2014, Per Baekgaard, Technical University of Denmark, DTU Informatics, Cognitive Systems Section

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions
of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
