Bee Monitor Element

Modified on 2016/05/08 11:33 by Maria Categorized as Usability Research
<div style="float: right; left-margin:20px; 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;
margin-right: 10px; margin-left: 10px;margin-bottom:10px">
{s:Element Info Panel
| title=New Element
| category=
| icon=[image|Element Icon|{UP(page-name)}icon.png]
| author=OkazoLab Team
| addin=Base Elements
| scope=Parent Event  
| usage=Presentation Screen,Status Screen, Code snippets 
| ownsnippets=no 
}


== Actions aligned with epochs of the parent event  ==

{| 
|- 
! Epoch
! Actions
|- 
| After experiment onset
| The element ...
|-
| Event rendered
|
|-
| Before event onset
|
|-
| After event onset
|
|-
| Control loop step
| The element ...
|-
| Before event offset
|
|-
| Before experiment offset
| The element ...
|-
|}

== Properties ==
=== Generic Properties ===
{| 
|- 
! Name
! Property  description
! Constraints
! Type
! Upon change
|- 
|  colspan="5"  bgcolor="#AADDDDD"  | General Plot Settings
|- 
| Show Axis
|  
| {s:atNormal}
| Boolean
| 
|- 
| Adaptive Resizing
|  
| {s:atNormal}
| Boolean
| 
|- 
| Rendering Size
| Defines the size of the generated XAML staircase plot in pixels. The plot is automatically stretched on rendering, but a larger rendering size improves the chart quality with some cost in performance. The rendering size is also used as the resulting image resolution, when the chart is saved into a file.
| 
| clSize
| 
|- 
| Show Gridlines
|  
| {s:atNormal}
| Boolean
| 
|- 
| Add Screen Clone
|  
| {s:atDesign}
| enum
| 
|- 
| High-Quality Rendering
|  
| {s:atNormal}
| Boolean
| 
|- 
| Plot Theme
|   
| {s:atNormal}
| Int32
| 
|-  
|  colspan="5"  bgcolor="#AADDDDD"  | Bee Plot Settings
|- 
| Plot Title
| 
| {s:atNormal}
| String
| 
|- 
| Show Gaze Marker
| 
| {s:atNormal}
| Boolean
| 
|- 
| Gaze Marker Color
| 
| {s:atNormal}
| stColor
| 
|- 
| Gaze Marker Fill
| 
| {s:atNormal}
| stColor
| 
|- 
| Gaze Marker Scale
| 
| {s:atNormal}
| Double
| 
|- 
| Show Mouse Marker
| 
| {s:atNormal}
| Boolean
| 
|- 
| Mouse Marker Color
| 
| {s:atNormal}
| stColor
| 
|- 
| Mouse Marker Fill
| 
| {s:atNormal}
| stColor
| 
|- 
| Mouse Marker Scale
| 
| {s:atNormal}
| Double
| 
|- 
|  colspan="5"  bgcolor="#AADDDDD"  | Results
|- 
| XAML Bee Plot
| Returns a live XAML control that can be used for direct binding to the Content property of the XAML ContentControl element, e.g. <ContentControl Content='{Binding OnlineChart}'/> ContentControl with a generated staircase plot can be added to the status screen or to the XAML Layout element.
| {s:atStatus}
| UIElement
| 
|- 
| Save Plot Now
| Assign a filename to save the generated plot at runtime
| {s:atWriteOnly}
| String
| 
|- 
| Review Plot
| Open a window with the plot preview
| {s:atDesign}
| Boolean
| 
|- 
|  colspan="5"  bgcolor="#AADDDDD"  | Video Results
|- 
| Video Capturing
| 
| {s:atDesign}
| Boolean
| 
|- 
| Video Encoder
| Defines an encoder that will handle video compression for the recorded videos. The list contains all video encoders installed in OS.
| {s:atDesign}
| enum
| 
|- 
| Configure Encoder
| Opens a configuration dialog of the selected video encoder (of supported)
| {s:atDesign}
| Boolean
| 
|- 
| Frame Rate
| 
| {s:atDesign}
| Int32
| 
|- 
| Output Folder
| Opens a dialog for selecting a local folder to store recorded videos
| {s:atDesign}
| String
| 
|- 
|  colspan="5"  bgcolor="#AADDDDD"  | Detection Results
|- 
| Fixation Number
| 
| {s:atStatus}
| Int32
| 
|- 
|  colspan="5"  bgcolor="#AADDDDD"  | Gaze Processing
|- 
| Radar Provider
| Defines which of the radar providers is used for positional input in this event. In each experiment, the radar providers includes the system mouse and all tracker elements. The selected radar provider controls the Radar Point property and input to the AOI elements in this event. When 'Auto' is chosen, the first tracker element is picked up. If there are no tracker elements, the system mouse is used by default.
| {s:atDesign}
| enum
| 
|- 
| AOI
|  
| {s:atNormal}
| enum
| 
|- 
| Sampling Rate
| Defines the sampling rate of the tracker hardware in Hz. Set zero value for auto-detection.
| {s:atNormal}
| Double
|  
|- 
| Exclusive Thresholds
| Defines whether the exclusive velocity and saccade thresholds are used by this element. The default value is false, which means that the same threshold values are shared with all eye-tracking analysis elements.
| {s:atDesign}
| Boolean
|  
|- 
| X Velocity Threshold
| Defines the saccade velocity threshold for the X-axes.
| {s:atNormal}
| Double
|  
|- 
| Y Velocity Threshold
| Defines the saccade velocity threshold for the Y-axes.
| {s:atNormal}
| Double
| 
|-
| Minimal Saccade Duration
| Defines the minimal duration threshold (in ms.) for the velocity-based saccade detection. If a saccade candidate shorter than the threshold, it's discarded after completion. Note that, the element can still be triggered at the start and peak velocity of the discarded saccades, when the triggering mode is not 'On the saccade end'. If you do not want to apply the minimal duration threshold, set the zero value.
| {s:atNormal}
| Double
| 
|-  
| Maximal Saccade Duration
| Defines the maximal duration threshold (in ms.) for the velocity-based saccade detection. If a candidate saccade shorter than the threshold, it's discarded after completion. Note that, the element can still be triggered at the start and peak velocity of the discarded saccades, when the triggering mode is not 'On the saccade end'. If you do not want to apply the maximal duration threshold, set the zero value.
| {s:atNormal}
| Double
| 
|-  
|}

+=== Properties inherited from clElement ===
{s:clElement Properties}

== ==
</div>
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************--><!--*****************************************************************************************************************************************************************************-->

'''Bee Monitor element''' allows monitoring gaze and mouse positions relative to the stimulus screen. Real-time updates of monitored plot can be captured into a video stream.

{TOC}

== Description ==

The element generates a 'bee' plot showing gaze and mouse positions as markers superimposed over a replica of the stimulus screen. The plot can be monitored on the status screen and captured into a video file.


== 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]
|}

== Video capturing ==

A screencast of the bee plot will be captured into a video file, if the '''Video capturing''' property is set to true. When capturing is enabled, the element creates a new video file on the onset of the parent event and ends recording on the offset. A name of the video file is automatically constructed of the current time and element's title. The file is stored in a selected folder or in the same folder with the experiment file.

The element allows selecting an encoder filter for video compression via the '''Video Encoder''' property. Since standard Windows encoders, e.g. 'Microsoft Video 1', may have problems with high-quality capturing, you can install and use any third-party video encoder. Many encoders allows adjusting encoding parameters, e.g. quality, via a configuration panel or configuration tool.

For all capturing tasks, we would recommend to use a free [https://en.wikipedia.org/wiki/H.264/MPEG-4_AVC|H.264/MPEG-4] encoder, called x264vfw. You can get the x264vfw installer on their [https://sourceforge.net/projects/x264vfw/|project website]. After the installation you can configure the x264vfm options via the '''Configure x264vfw''' tool.         



== Practical Use ==
=== Technique 1 ===

# Step 1
# Step 2

=== Technique 2 ===

# Step 1
# Step 2

@@ csharp // Check the trial outcome. Result and RT just other user variables
// insert code snippet here..
@@

== Notes ==

* Insert Notes here..
* Insert Notes here..
Meta Keywords: EventIDE, eye-tracking, gaze position, Okazolab, usability research
Meta Description:
Change Comment:
EventIDE Wiki

Navigation¶

Bee Monitor Element
