SMI Tracker Element

Modified on 2018/08/03 05:43 by Administrator Categorized as Elements, Eye Trackers
<div style="margin-right: 10px; margin-left: 16px; margin-bottom:10px; float: right; width: 500px; overflow: hidden; height: auto; padding: 0px; background: #fafafa; background: -webkit-gradient(linear, left top, left bottom, from(#fbfbfb), to(#fafafa));background: -moz-linear-gradient(top, #fbfbfb, #fafafa);border: 1px dashed #ddd;box-shadow: 0 0 0 3px #fff, 0 0 0 5px #ddd, 0 0 0 10px #fff, 0 0 2px 10px #eee;">
== Summary ==
{s:Element Info Panel
| title=SMI Tracker
| category=Eye trackers
| icon=[image|Element Icon|{UP(SMI-Tracker-Element)}SMI-Tracker-Element-Icon.png]
| author= OkazoLab
| addin= SMI
| scope= Experiment
| usage= Snippets
| ownsnippets= None
}
== Synchronized actions ==
{|
|-
! Epoch
! Actions
|-
|-
| On Experiment Start                        
| Starts processing tracker samples
|-
| On Experiment Start                        
| Stops processing tracker samples
|-
|}
== Properties ==
{|
|-
! Name
! Description                              
! Constraints
! Type
! On<br/>runtime<br/>change
|-
| colspan="5" bgcolor="#AADDDDD" | SMI Settings
|-
| License Key        
| The network address of the remote SMI computer in IP format: xxx.xxx.xxx.xxx        
| {s:atDesign}        
| String        
|  
|-
| SMI address        
| The network address of the remote SMI computer in IP format: xxx.xxx.xxx.xxx        
| {s:atDesign}        
| String        
|  
|-
| SMI port        
| The UPD port number on the remote SMI computer        
| {s:atDesign}        
| Int32        
|  
|-
| Local address        
| The network address of the given computer in IP format: xxx.xxx.xxx.xxx        
| {s:atDesign}        
| String        
|  
|-
| Local port        
| The UPD port number on the given computer that is used for communication with the SMI eye-tracker        
| {s:atDesign}        
| Int32        
|  
|-
| Gaze Mode        
| Defines which eye is used for gaze tracking within EventIDE via the radar properties of events        
| {s:atDesign}        
| enTrac..        
|  
|-
| System Info        
| The system info of SMI tracker        
| {s:atStatus}        
| System..        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Tracker Samples
|-
| Newest Samples        
| Returns an array of the most recent tracker samples. The array is updated every Control Loop cycle.        
| {s:atStatus}        
| Sample..        
|  
|-
| Newest Sample        
| Returns the newest tracker sample. The sample is updated every Control Loop cycle.        
| {s:atStatus}        
| Sample..        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | SMI Events
|-
| Event Triggering        
| Turn on/off triggering by an incoming SMI event        
| {s:atDesign}        
| Boolean        
|  
|-
| Is Triggered        
| Indicates whether any SMI event has triggered the element atleast once
 while the parent event is active        
| {s:atNormal}        
| Boolean        
|  
|-
| SMI Event        
| Exposes a content of the most recently received SMI event        
| {s:atStatus}        
| EventS..        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | SMI Logging
|-
| SMI Log Folder        
| Select a folder for storing the generic SMI logs        
| {s:atDesign}        
| String        
|  
|-
| Is SMI Logging        
| Turn on/off generic SMI logging        
| {s:atDesign}        
| Boolean        
|  
|-
| Log Level        
| Level of info in the SMI generic log files        
| {s:atDesign}        
| Int32        
|  
|-
| Send Message Now        
| Runtime command (SMI logging has to be enabled) that writes a custom text message into the SMI log file        
| {s:atRuntimeAction}        
| String        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Remote Commands
|-
| SMI Command        
| The text of the command (max 256 chars) that will be send to the tracker on [Send Command] action        
| {s:atNormal}        
| String        
|  
|-
| Send Command        
| Set to true in a code snippet at runtime to send the current value of [SMI Command] to the tracket        
| {s:atNormal}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | 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.        
| {s:atDesign}        
| Boolean        
|  
|-
| Gain X        
| Defines the gain coefficient for the X axis
in the GLM calibration model: X='GainX'*x+OffsetX        
| {s:atNormal}        
| Double        
|  
|-
| Gain Y        
| Defines the gain coefficient for the Y axis
in the GLM calibration model: Y='GainY'*y+OffsetY        
| {s:atNormal}        
| Double        
|  
|-
| Offset X        
| Defines the offset coefficient for the X axis
in the GLM calibration model: X=GainX*x+'OffsetX'        
| {s:atNormal}        
| Double        
|  
|-
| Offset Y        
| Defines the offset coefficient for the Y axis in the GLM calibration model: Y=GainY*y+'OffsetY'        
| {s:atNormal}        
| Double        
|  
|-
| Affine Mode        
| Defines the affine transformation (scale, translation and rotation) is used for calibration instead on the simpler GLM transformation (scale and translation)        
| {s:atNormal}        
| Boolean        
|  
|-
| Affine Rotation        
| Defines the rotation angle (deg) for the affine calibration        
| {s:atNormal}        
| Double        
|  
|-
| Save Calibration Now        
| Provides a runtime command that saves the current GLM calibration into a XML file. To run the command at runtime, assign a file name to this property.        
| {s:atRuntimeAction}        
| String        
|  
|-
| Load Calibration Now        
| Provides a runtime command that loads the GLM calibration values from a XML file. To run the command at runtime, assign a file name to this property.        
| {s:atRuntimeAction}        
| String        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | 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.        
| {s:atRuntimeAction}        
| 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.        
| {s:atNormal}        
| clPoint        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Filters
|-
| Smoothing Ratio        
| Defines a ratio for the fast FIR smoothing filter, which is applied to the gaze tracking within EventIDE. The filter convolves every new tracking position with the previous ones.
The property value defines a tap weight for the previous data,
such that the convolution looks like: X=(Xn*(1-Ratio)+Xn-1*Ratio)/2. The value has to be positive and less than 1 (0 means no filtering).        
| {s:atNormal}        
| Double        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Logging
|-
| Log Folder        
| Opens the dialog for selecting a local folder that will hold all tracking logs        
| {s:atRuntimeAction}        
| String        
|  
|-
| Open Log Designer        
| Opens a designer window where the log format can be defined.        
| {s:atDesign}        
| 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.        
| {s:atNormal}        
| 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.        
| {s:atNormal}        
| String        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Runtime
|-
| Radar Point        
| Returns the newest calibrated tracking position provided by the tracker at runtime        
| {s:atNormal}        
| clPoint        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Perspective Correction
|-
| Perspective Correction        
| Defines...        
| {s:atNormal}        
| Boolean        
|  
|-
| Configure Perspective        
|         
| {s:atDesign}        
| Boolean        
|  
|-
| Viewer Position        
| Defines...        
| {s:atNormal}        
| Point3D        
|  
|-
| Tracker Position        
| Defines...        
| {s:atNormal}        
| Point3D        
|  
|-
| Focal Length        
| Defines...        
| {s:atNormal}        
| Double        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Control
|-
| Is Enabled        
| If set to false the element is completely omitted when the experiment is run        
| {s:atDesign}        
| Boolean        
|  
|-
| Title        
| Title of the element        
| {s:atDesign}        
| String        
|  
|-            
|}
== ==
</div>
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
'''SMI Tracker Element''' enables support for all models of SMI eye-trackers in EventIDE. Important note: the SMI SDK has to be installed on a computer before using this element. Another option is to get the iViewXAPI.dll from SDK and place manually in the AddIns subfolder.<br><br>
{TOC}
== Description ==
...
== Snapshots ==
{|
| [imageleft|Snapshot 1 <br/>|{UP(page - name)}*-sm.png |{UP(page - name)}*.png]
|| [imageleft|Snapshot 2 |{UP(page - name)}*-sm.png |{UP(page - name)}*.png]
|}
== Practical Use ==
...
=== Technique 1 ===
# Step 1
# Step 2
...
=== Technique 2 ===
# Step 1
# Step 2
...
<div style="margin-left:0px; margin-right:10px; margin-top:10px; width: auto; overflow: hidden; height: auto; background: #fafafa; background: -webkit-gradient(linear, left top, left bottom, from(#fbfbfb), to(#fafafa));background: -moz-linear-gradient(top, #fbfbfb, #fafafa);border: 1px dashed #ddd;box-shadow: 0 0 0 3px #fff, 0 0 0 5px #ddd, 0 0 0 10px #fff, 0 0 2px 10px #eee;">
@@ csharp // Check the trial outcome. Result and RT just other user variables
// insert code snippet here..
@@</div>           
...
== Notes ==
...
* Insert Notes here..
* Insert Notes here..
Meta Keywords:
Meta Description:
Change Comment:
EventIDE Wiki

Navigation¶

SMI Tracker Element
