C#开发EyeLink眼动仪的实验程序

【题外话】

Eyelink眼动仪是SR Research推出的一款眼动仪，很多高校都在使用其做实验。其官方提供了COM的接口，所以支持COM接口的开发平台都可以开发使用。官方甚至提供了一个C#的样例供参考，不过这个样例相比起其他的VC++的样例而言功能过于简单，程序本身也比较乱，再加上国内关于EyeLink的资料又比较少，所以这里我简要写下我使用EyeLink眼动仪的开发框架，方便大家开发。

本文地址：http://www.cnblogs.com/mayswind/p/3417211.html

【文章索引】

1. 准备工作
2. EyeLink实验的操作流程
3. EyeLink的基本使用方法
4. EyeLink的高级使用方法

【一、准备工作】

虽然SR Research提供的大多数样例都是基于VC++的，但由于C#开发快速高效，同时在实现复杂功能时C#更容易开发，所以我还是选择了使用C#开发实验程序，而不是VC++。SR Research比较有意思的是，官方虽然提供了所有的说明文档以及开发工具包，但是这些都需要从官网的论坛才可以下载，而且官网论坛的注册是需要人工审核的，所以注册一定千万不要着急。好在审核也不会慢，去除时差的原因没有多久就能通过审核。

注册完成以后，首先需要下载开发工具包，该工具包里包括了SDK文件以及几个说明文档还有几个示例程序。地址见下：

https://www.sr-support.com/showthread.php?6-Windows-Display-Software

程序员开发手册（EyeLink Programmers Guide.pdf）就在安装后的目录中的Docs中，虽然是C语言版本的而且也不是使用的COM接口，但对于了解SDK还是有帮助的。当然也可以单独下载，地址见下：

https://www.sr-support.com/showthread.php?4-EyeLink-C-Programmers-Guides

所有的自带样例程序都在安装目录下的SampleExperiments目录，COM接口的都在com目录下，其中还有一个C#的样例程序。而EyeLink提供的COM接口文件位于Libs目录下，文件名为“SREyeLink.dll”，直接在C#里引用即可。

【二、EyeLink实验的操作流程】

一般使用EyeLink进行实验的都要遵循以下的流程：

1、程序开始界面，可能介绍本实验的情况及提示接下来按什么键进入实验等等。

2、一般正式进入实验流程后首先按C键进入Calibration界面进行眼睛的校准，一般为9点校准（可以自行设置），如果一个点校准失败会在所有点校准后重新校准。

3、眼睛校准成功后按V键进入Validation界面进行刚才校准结果的验证。

4、验证成功后开始实验，一个实验可能有多个Trail组成，在所有Trial之前或每个Trial之前可能需要Drift使受试者注视屏幕中心（位置可自定义）以继续。

5、如果有多个Trial将依次执行。

【三、EyeLink的基本使用方法】

EyeLink提供的COM接口总体还是很友好的，常见的有以下几个类：

1、EyeLink：与EyeLink操作主要的类，提供连接Host PC、创建EDF文件、向Host PC发送命令和向EDF中记录信息等等，常见的方法如下：

方法名	含义
void open("Host PC IP", 0);	连接到指定Host PC，Host PC IP通常为100.1.1.1
void close();	关闭指定连接
void openDataFile("fileName");	在Host PC创建指定文件名的EDF文件以供记录
void receiveDataFile("fileName", "localPath");	将Host PC记录的指定文件名的EDF传回到本地路径
void startRecording(true, true, true, true);	开始记录注视点信息（四个选项可以设置是否记录指定内容）
void stopRecording();	结束记录注视点信息
bool isRecording();	获取是否正在记录注视点信息
void sendCommand("command");	向Host PC发送指定的指令
void sendMessage("message");	向Host PC发送指定的信息，记录在EDF文件中
void doTrackerSetup();	进入实验流程，允许用户按C和V执行相应操作或按Enter显示镜头内容
void doDriftCorrect(x, y, true, true);	要求受试者看住指定的(x, y)点以继续
void setOfflineMode();	Host PC进入Offline Mode，通常实验结束后要执行该操作
short eyeAvailable();	获取摄像头跟踪到的眼睛（可以转换为EL_EYE枚举）
short getLastButtonPress(out pressTime);	获取按键信息（比如可以获取连接在Host PC上的手柄的按键）
Sample getNewestSample();	获取注视点信息

2、EyeLinkUtil：提供了几个常用工具方法，如提供当前时间、进入实时模式等等。

方法名	含义
void beginRealTimeMode(time);	开始指定时间（毫秒）的实时模式
void endRealTimeMode();	结束实时模式
double currentTime();	获取当前时间（毫秒）
ELGDICal getGDICal();	获取EyeLink GDICal

3、ELGDICal：通过将窗口的Handle传给该类，实现由EyeLink SDK控制直接在界面上绘制Calibration、Validation以及Drift等界面，同时开发者也可以直接在界面线程上执行逻辑或绘制相应内容，而无需担心界面无响应而创建子线程等等。

方法名	含义
void setCalibrationColors(foreColor, backColor);	设置Calibration、Validation、Drift等界面的前景色和背景色
void setCalibrationWindow(hWnd);	设置上述界面的窗口Handle
void enableKeyCollection(true/false);	设置是否允许通过键盘控制EyeLink SDK操作（如C、V、Enter）

EyeLink基本使用非常简单，就如同给出的C#的样例一样，在这里给出一个简单的使用，比如直接在界面线程上执行代码（this这里就是指当前窗体）：

 EyeLink eyeLink = new EyeLink();//创建EyeLink对象
 eyeLink.open("100.1.1.1", );//连接到Host PC
 eyeLink.openDataFile("test.edf");//在Host PC创建指定文件名的EDF以供记录
 eyeLink.sendCommand("file_event_filter = LEFT,RIGHT,FIXATION,SACCADE,BLINK,MESSAGE,BUTTON");//设置事件或记录的内容，下同
 eyeLink.sendCommand("file_sample_data = LEFT,RIGHT,GAZE,AREA,GAZERES,STATUS");
 eyeLink.sendCommand("link_event_filter = LEFT,RIGHT,FIXATION,SACCADE,BLINK,BUTTON");
 eyeLink.sendCommand("link_sample_data = LEFT,RIGHT,GAZE,GAZERES,AREA,STATUS");
 eyeLink.sendMessage(String.Format("DISPLAY_COORDS {0} {1} {2} {3}", this.Left, this.Top, this.Width, this.Height));//设置窗口的范围

 EyeLinkUtil eyeLinkUtil = new EyeLinkUtil();//创建EyeLinkUtil对象
 ELGDICal gdiCal = eyeLinkUtil.getGDICal();//创建EyeLinkGDICal对象

 gdiCal.setCalibrationWindow(this.Handle.ToInt32());//将窗体句柄传给EyeLink SDK
 gdiCal.enableKeyCollection(true);
 eyeLink.doTrackerSetup();//开始进行设置阶段（Calibration、Vadation等）
 gdiCal.enableKeyCollection(false);

 gdiCal.enableKeyCollection(true);
 eyeLink.doDriftCorrect((Int16)(this.Width / ), (Int16)(this.Height / ), true, true);//所有Trial前或每个Trial前让受试者注视指定位置以开始Trial
 gdiCal.enableKeyCollection(false);

 eyeLink.startRecording(true, true, true, true);//开始记录EDF文件
 Double st = eyeLinkUtil.currentTime();

 while ((st + ) > eyeLinkUtil.currentTime())//循环20秒程序结束
 {
     EL_EYE eyeUsed = (EL_EYE)eyeLink.eyeAvailable();//获取当前眼睛使用情况
     Sample sample = eyeLink.getNewestSample();//获取当前注视点

     if (sample == null || eyeUsed == EL_EYE.EL_EYE_NONE)
     {
         continue;
     }

     if (eyeUsed == EL_EYE.EL_BINOCULAR)
     {
         eyeUsed = EL_EYE.EL_LEFT;//如果两只眼睛同时被捕捉到则使用左眼
     }

     Single x = sample.get_gx(eyeUsed);//获取注视点相对窗口的横坐标
     Single y = sample.get_gy(eyeUsed);//获取注视点相对窗口的纵坐标
     Single pa = sample.get_pa(eyeUsed);//获取瞳孔大小

     if (x == (Single)EL_CONSTANT.EL_MISSING_DATA || y == (Single)EL_CONSTANT.EL_MISSING_DATA || pa <= )
     {
         continue;
     }

     //TODO: 在这里处理x、y坐标等
 }

 eyeLink.sendCommand("close_data_file");//关闭Host PC上的EDF文件
 eyeLink.receiveDataFile("test.edf", "本机文件路径");//将Host PC上的EDF文件传回到测试机

 eyeLink.setOfflineMode();//将Host PC设置为离线状态（非实验进行状态）
 eyeLink.stopRecording();//结束记录EDF文件
 eyeLink.close();//关闭与Host PC的连接

 eyeLink = null;
 eyeLinkUtil = null;

【四、EyeLink的高级使用方法】

有了上述这些还不够，比如：

1、虽然上述我们能记录EDF文件，但是如果有多个Trial的话我们还希望能在EDF文件中予以区分。所以在每个Trial前后我们还需要这样去做：

 eyeLink.sendCommand(String.Format("record_status_message 'TRIAL {0}'", trialIndex));
 eyeLink.sendMessage(String.Format("TRIALID {0}", trialIndex));
 eyeLink.startRecording(true, true, true, true);

 //Trial逻辑

 eyeLink.stopRecording();

2、如果我们在Trial中显示了图片，同时我们希望EDF Viewer在查看时也能将对应的图片显示出来，那么我们还需要在startRecording之前执行这样一句话，去让EDF Viewer打开指定路径下的图片。

 eyeLink.sendMessage(String.Format("!V IMGLOAD FILL {0}", imagePath));

3、如果我们希望受测者能够使用按键进行Trial的操作（比如按某键表示完成或跳过该Trial之类的），我们还需要获取按键的信息，其中如果我们还需要在EDF文件中显示出按键的情况，我们还需要向Host PC发送一条信息（下列代码中第6行）。

 Double pressTime = ;
 Int16 buttonCode = eyeLink.getLastButtonPress(out pressTime);

 if (buttonCode != )
 {
     eyeLink.sendMessage(String.Format("ENDBUTTON {0}", buttonCode));
     //TODO: 执行相关按键的逻辑
 }

4、如果我们希望在Drift的过程中，受测者在将眼睛注视到指定的点后还需要按指定的键才能继续的话，我们还需要在开始的配置过程中写如下的代码（这里使用的是按键5）：

 eyeLink.sendCommand("button_function 5 'accept_target_fixation'");

附一个我写的C#上使用EyeLink的框架（MIT LICENSE）：http://files.cnblogs.com/mayswind/DotMaysWind.EyeLink.rar

【相关链接】

1、SR Research Support Site：https://www.sr-support.com/forums/