Eyelink Toolbox

Help

Quickstart guide

Documentation

Contents of the toolbox

Further help

Bugs and missing functions

FAQ

 


Quickstart guide


For a complete list of available functions type "EYELINK" in the MATLAB command window
For an explanation of any particular Eyelink function just add a
question mark "?" after a command.
E.g. for 'Initialize', try either of these equivalent forms:
EYELINK('Initialize?')
EYELINK initialize?

[optional arguments]:
Brackets in the function list, e.g. [remport], indicate optional arguments, not
matrices. Optional arguments must be in order, without omitting earlier ones.

 

Documentation

There's no eyelinktoolbox manual (volunteer, anyone?). But there's a few places were you can find info that should help you get started:

1. Study the demo's provided with the toolbox
2. Typing eyelink at the matlab prompt provides an overview of possible eyelink commands
3. There's some additional info in the faq.
4. As pointed out by Jochen Laubruck, the original eyelink programming manual is a good place to find out about which commands can be passed via the eyelink toolbox function EYELINK('command', 'formatstring', [...]). Look for eyecmd_printf() and the section titled "Useful Eyelink Commands".

5. Search the psychtoolbox forum's messages.
6. Post a question on the forum.
7. Eyelinktoolbox paper.



Contents of the toolbox


Contents of the EyelinkToolbox folder:
-Contents.m: this file.
-Changes.m: documents changes
-EyelinkBasic
EYELINK.mex file and a collection of m-files
-EyelinkDemos
-Short demo: file 'eyelinkexample.m'
Shows a simple gaze cursor. Blinking erases the screen.
simple demo program to illustrating the use of this
toolbox. Note that it uses the 'dotrackersetup' contained
within the mex file, rather then the m-file based version.
-EyelinkDemoExperiment: 'eyelinkdemoexp.m': a simple demo experiment
with the flavour of the c-coded demo experiment of Dave Stampe '97.
there are two (types of) trials:
simpletrialdemo: a simple gaze recording example
realtimedemo: a simple gaze-dependent display example
-Palmer demo: Simple experiment to measure response time using eye movements.

-EyelinkSounds: a few sounds that you can add to your system to recreate
that particular Eyelink Mac-experience.
On a Mac, add the sounds to your system by dragging
the sound files this folder onto your closed system folder.
You can't have any programs open when copying sound
resources to your system.
use 'testeyelinksounds' to test for the presence of all required sounds

-EyelinkTests:
-testgetkeyforeyelink.m :
Function that tests the getkeyforeyelink routine and
computes the time taken by the getkeyforeyelink function call
-testcalls.m
Program that tests if most of the eyelink routines are operational,
also useful as illustration of the eyelink function calls(no calibration).
-testcalib.m :
Tests and illustrates the eyelink calibration routine.
-testsampletime.m :
Program which performs multiple timing-tests on functions related
to sampling eye position.
-EXGetEyeLinkTime.m
tests the new requesttime and readtime functions.
-testbutton.m
test of the new buttonstates and lastbuttonpress functions.

Some things to observe before using the toolbox:
*The EyelinkToolbox folder can be put anywhere on your harddisk as long as you make
sure that Matlab knows about it's existence. So use the 'set path' command under the
file menu. You only need to add the 'EyelinkToolbox' folder
*The sounds the EYELINK toolbox uses as well as many other defaults can be modified
in the 'meyelinkinit.m' file in the demo-experiment folder. As this is probably experiment
specific, we decided not to put this file in the toolbox but rather in the demo-experiment
folder.

*Currently, there are both m-file as well as mex-file implementations of dotrackersetup,
and dodriftcorrection. If there are no problems with timing, it is our
idea to enable only the m-file versions in later releases. The great advantage
of using only m-files is that this makes the code much more portable and flexible to use.
*we have not done any exhaustive testing on the timing of this toolbox, so do not
assume that things are as they used to be with the pure c-code versions of your experiments.
*The current version is Powermac only. While we do have the intention to port the mex-code to
the windows version, this currently has no great priority for us.
We welcome any observations, suggestions that may help us improve this toolbox.
*The c-source code, and a Metroworks Codewarrior project used to build the EYELINK.mex file are available upon request.

Further help

Post questions on the PsychToolbox mailinglist, or directly to us (f.w.cornelissen@med.rug.nl). Note that this toolbox is NOT provided by SR Research, the manufacturer of the Eyelink gazetracker, so do not contact them about this.

 

Bugs and missing functions

 

Most of the Eyelink functions that are avaible in C are also available
under Matlab. If any particular function you need is still missing, let us know
and we'll try to incorporate it into a next release. In case you decide to add
or modify functions yourself, please send us the modified code.
If you think you've found a bug, please tell us: f.w.cornelissen@med.rug.nl
It will help greatly if you can supply a minimal-length program that exhibits
the bug.