Mouse Tracker Element

Modified on 2018/08/02 23:38 by Administrator Categorized as Base Elements, Elements, Mouse Touch Joystick
<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=Mouse Tracker
| category=Mouse Touch Joystick
| icon=[image|Element Icon|{UP(Mouse-Tracker-Element)}Mouse-Tracker-Element-Icon.png]
| author= OkazoLab
| addin= Base Layer
| 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" | Settings
|-
| Input Device        
| Defines what pointing devices can provide input to the mouse tracker        
| {s:atNormal}        
| enMous..        
|  
|-
| Show Cursor In Calibration        
| Defines whether the mouse cursor is shown during the GLM calibration procedure        
| {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        
|  
|-
| 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" | 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>
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
The Mouse tracker element records a complete trajectory of mouse movements relatively to the stimulus screen. In case of unexpected failures in recording, you may need to increase the timeout value (in ms) of DWord key 'HKEY_Current_User\Desktop\LowLevelHooksTimeout' in Windows Registry
{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¶

Mouse Tracker Element
