Commit 2a33e3e5 authored by Thiago Santini's avatar Thiago Santini

Starts README

parent c9582da1
WHAT IS EYEREC?
EyeRec is a data acquisition software for head-mounted eye trackers. Its
main raison d'être is to provide an open platform to replace the data
acquisition functionality from eye-tracker vendors software, which typically
are expensive and closed-source. Thus, if something is not working properly,
you can fix it yourself instead of relying on the vendor to fix it; for
instance, if the pupil detection algorithm does not suit your needs.
For a replacement for the data analysis functionality, we recommend
Eyetrace, which can be downloaded at:
http://www.ti.uni-tuebingen.de/Eyetrace.1751.0.html
WHICH EYE TRACKERS ARE SUPPORTED?
Officially, the Dikablis Pro and Dikablis Essential because these are the
ones we have access to.
Theoretically, as long as your cameras are accesible through Microsoft
DirectShow and at least one of them has a callback functionality, everything
should work out of the box.
If you are building your own eye tracker out of web cameras, we have
succesfully tested EyeRec with the Microsoft Lifecam VX-1000.
RUNNING:
Prior to running, make sure you have the Visual C++ 2012 x86 run-time
components installed. If not, you can install them with by running
vcredist_x86.exe or downloading the installer directly from Microsoft at:
https://www.microsoft.com/en-us/download/details.aspx?id=30679
Additionally, you may need to install drivers to access your eye tracker
cameras. For instance, Dikablis eye trackers require the VRMagic drivers,
which can be downloaded at:
https://www.vrmagic.com/imaging/downloads/
Make sure you have the 32-bits version of the drivers!
BUILDING:
Currently, the building is in the form of a QtCreator project (EyeRec.pro)
The particulars of the test build system we use are:
- QtCreator 3.3.2
- Qt 5.4.1 (MSVC 2010, 32bit)
- Visual Studio 2012
For the 32-bits version, building should be as simple as installing Visual
Studio and QtCreator, opening the project, running qmake, and building. All
the dlls that EyeRec requires are already packed in the ./deps directory.
64-bits builds are not officially supported at the moment. If one is needed,
you will need to compile the dependencies for 64 bits a priori.
DEPENDENCIES:
Qt >= 5.4
OpenCV >= 3.0.0
VideoMan 1.1
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment