Page History: EyeLink Tracker Element
Compare Page Revisions
Page Revision: 2016/05/17 17:26
|
EyeLink Element
|
| Info |
| Category: |
Eye Trackers |
|
AddIn: |
EyeLink eye-tracking |
| Creator: |
OkazoLab Team |
|
Scope: |
Entire experiment (global) |
| Owns Snippets: |
no |
|
Usage: |
Runtime Screen,Snippets |
Actions aligned with epochs of the parent event
| Epoch | Actions |
|---|
| After Onset | The element starts analyzing the selected signal |
| Control Loop step | Latest signal samples is analyzed within the selected analysis window and the signal plot gets updated. |
| Before Offset | The element stops analyzing the selected signal |
Properties
Generic Properties
| Name | Description | Attributes | Value Type | Proxy Changed Actions |
|---|
| EyeLink settings |
| Network address | The network address of a EyeLink computer in IP format: xxx.xxx.xxx.xxx | | String | |
| Tracking target | Indicates which eye(s) provides radar data for the parent event. If set to binocular, the right eye is used. | | EL_EYE | |
| Dummy Testing | If true, presence of the Eyelink device is emulated for testing purposes. No real data is received. | | Boolean | |
| Sampling |
| Filter for samples | If false, the raw positional data will be modified with the calibration parameters only, if true, the current filters will be applied as well. The value affects only samples and the logged data but not the positions used for tracking. | | Boolean | |
| Samples Number | Number of Eyelink samples taken in the recent request (made in OnRunning). | | Int32 | |
| Sample time | Array of recent time stamps. | | Double[] | |
| Left eye | Array of the recent tracked positions for the left eye. | | clPoint[] | |
| Right eye | Array of the recent tracked positions for the right eye. | | clPoint[] | |
| Left pupil | Array of the recent pupil sizes for the left eye. | | Single[] | |
| Right pupil | Array of the recent pupil sizes for the right eye. | | Single[] | |
| EDF Logging |
| Select EDF folder | | | DesignTimeAction | |
| EDF Folder | | | String | |
| Is Logging | Turn on/off logging with EDF file on the EyeLink host computer. | | Boolean | |
| Include Events | Turn on/off EyeLink events logging in EDF file. | | Boolean | |
| EDF Message | The text message that is sent with a time stamp to an EDF file on Send Message action. | | String | |
| Send Message | Setting to true in a code snippet (when EDF Logging is enabled) initiates sending the current EDF Message to an EDF file. | | Boolean | |
| Drift Correction |
| Recalibrate Now | If set to true in a code snippet, the drift correction is performed - the calibration offsets are adjusted to match the current eye position and custom recalibration point. This action can be used for the runtime drift correction. | | Boolean | |
| Recalibration Point | Custom recalibration point for the runtime drift correction. Empty value by default denotes the screen center in any resolution. | | clPoint | |
| Perfomance |
| Amount of the lost data | The total amount of eyetracking data that have been lost due to a perfomance lag, in bytes. If the value greater than 0 after runtime, consider an increase of the memory buffer size | | UInt64 | |
| MaxRefreshTime | Largest time interval between two read-outs that has been registred for the last runtime, in ms | | UInt64 | |
| LastRefreshTime | The current time interval between two read-outs, in ms | | UInt64 | |
| Buffer size | Size of a circular memory buffer, in bytes, that is used to store eyetracker data arriving between in two read-outs | | Int32 | |
+=== Properties inherited from clTrackerElement ===
| Name | Description | Constraints | Type | Upon Runtime Change |
|---|
| GLM Calibration |
| Run GLM Calibration | Runs the GLM calibration procedure, which calculates two pairs of linear coefficients for mapping of the tracker input into the screen coordinates. The calculated coefficients are automatically applied at runtime. | | Boolean |
| Gain X | Defines the gain coefficient for the X axis in the GLM calibration model: X='GainX'*x+OffsetX | | Double | |
| Gain Y | Defines the gain coefficient for the Y axis in the GLM calibration model: Y=GainY*y+OffsetY | | Double |
| Offset X | Defines the offset coefficient for the X axis in the GLM calibration model: X=GainX*x+OffsetX | | Double | |
| Offset Y | Defines the offset coefficient for the Y axis in the GLM calibration model: Y=GainY*y+OffsetY | | Double | |
| Drift Correction |
| Recalibrate Now | Runtime command that helps to correct drifts in tracking data.Correction is done by recalibration of the latest tracker position into a custom screen point defined by the 'Recalibration Point' property.nAs result, the offsets of the GLM calibration get adjusted (but not gains) to compensate a drift in further data. | | Boolean |
| Recalibration Point | Defines the screen point to which the tracker position will be recalibrated on calling 'Recalibrate Now' action. The default auto value always denotes the screen center. | | clPoint |
| Logging |
| Log Folder | Opens the dialog for selecting a local folder that will hold all tracking logs | | String |
| Open Log Designer | Opens a designer window where the log format can be defined. | | Boolean |
| Is Logging | Defines whether logging is turn on/off. The value can be changed at any moment at runtime allowing selective logging during the relevant periods only. | | Boolean | |
| User Field | Defines the custom user data that is added to every line in the log file. The property can be used for recording varying status information (e.g. trial number) together with the tracker data. The string value may contains multiple fields separated by delimiter. | | String | Once a string value is assigned, it is added to every new upcoming line in the log until a new assignment is made. |
+=== Properties inherited from clElement ===
Inherited properties of clElement
| Name | Description | Constraints | Value Type | Upon Change |
|---|
| Control |
| Is Enabled | If set to false the element is completely omitted when the experiment is run. | | Boolean |
|
| Title | Title of the element. | | String |
|
The element allows/is capable of doing something in experiments
Description
Short description
Snapshots
 Snapshot 1
| Snapshot 2 |
Practical Use
Technique 1
- Step 1
- Step 2
Technique 2
- Step 1
- Step 2
// Check the trial outcome. Result and RT just other user variables
// insert code snippet here..
Notes
Insert Notes here..