Document Analyzer Element

Modified on 2018/08/22 02:36 by Administrator Categorized as Elements, Usability Research
<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=Document Analyzer
| category=Usability Research
| icon=[image|Element Icon|{UP(Document-Analyzer-Element)}Document-Analyzer-Element-Icon.png]
| author= OkazoLab
| addin= Usability Research
| scope= Parent event
| usage= Snippets
| ownsnippets= None
}
== Properties ==
{|
|-
! Name
! Description                              
! Constraints
! Type
! On<br/>runtime<br/>change
|-
| colspan="5" bgcolor="#AADDDDD" | General Plot Settings
|-
| Show Axis        
| Defines whether the axis are visible on the scanpath plot        
| {s:atNormal}        
| Boolean        
|  
|-
| Rendering Size        
| The rendering size also defines the image resolution, when the plot is saved into an image file or video.        
| {s:atNormal}        
| clSize        
|  
|-
| Show Gridlines        
| Defines whether the major tick gridlines are shown on the plot.        
| {s:atNormal}        
| Boolean        
|  
|-
| Add Screen Clone        
| Defines whether a clone of the presentation screen is shown at the background of the plot.        
| {s:atDesign}        
| enScre..        
|  
|-
| Rendering Quality        
| Defines the quality and speed the plot rendering        
| {s:atNormal}        
| Int32        
|  
|-
| Plot Theme        
| Defines a visual theme for the plot        
| {s:atNormal}        
| Int32        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Scanpath Plot Settings
|-
| Plot Title        
| Defines the title shown on the scanpath plot        
| {s:atNormal}        
| String        
|  
|-
| Show Gaze Marker        
| Defines whether a marker of the current gaze position is shown on the scanpath plot        
| {s:atNormal}        
| Boolean        
|  
|-
| Gaze Marker Color        
| Defines the color for the gaze marker        
| {s:atNormal}        
| stColor        
|  
|-
| Fixation Marker Scale        
| Defines the scale of the fixation markers        
| {s:atNormal}        
| Double        
|  
|-
| Fixation Marker Color        
| Defines the color of the fixation markers        
| {s:atNormal}        
| stColor        
|  
|-
| Saccade Line Thickness        
| Defines the line thickness of the saccade lines        
| {s:atNormal}        
| Double        
|  
|-
| Saccade Line Color        
| Defines the color of the saccade arrows and fixation indices        
| {s:atNormal}        
| stColor        
|  
|-
| Token Marks        
| Defines the color of text tokens marked hit the gaze fixations        
| {s:atDesign}        
| Int32        
|  
|-
| Token Color        
| Defines the color of text tokens marked by gaze fixations        
| {s:atNormal}        
| stColor        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | AOI
|-
| Document Element        
| Selects a document element for the eye-tracking analysis.        
| {s:atDesign}        
| String        
|  
|-
| Custom AOIs        
| Selects a visual element, whose viewport defines an on-screen AOI for the eye-tracking analysis.        
| {s:atNormal}        
| IColle..        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Results
|-
| Reset Scanpath Now        
| The command that resets the current scanpath data and plot. Assign 'true' in the snippets to invoke this command at runtime.        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| XAML Scanpath Plot        
| Returns a live XAML control containing the scanpath plot. The property that can be used for binding to the Content property of the XAML ContentControl element, e.g. <ContentControl Content='{Binding XAMLScanpathPlot}'/>. The bound ContentControl can be then added to the status screen or to the GUI Panel element.        
| {s:atNormal}        
| UIElem..        
|  
|-
| Custom Data        
| Defines a custom data (string type) that is associated with a single scanpath point. In a typical scenario, you update this property in snippets, e.g. with a real-time EEG score. Then, upon a fixation, a new scanpath point will be added with the current value of the custom data string. The custom data is saved in the scanpath data file or, can be accessed by 'Scanpath Points' property.        
| {s:atNormal}        
| String        
|  
|-
| Scanpath Points        
| Returns an array containing recorded scanpath points. Each point is represented by clScanPathPoint struct.         
| {s:atNormal}        
| clDocu..        
|  
|-
| Save Plot Now        
| The command that saves the current scanpath plot into an image file.  Assign a filename in the snippets to invoke this command at runtime. The extension of the filename (e.g. .png,.bmp, .jpg) will define a format of the image file.        
| {s:atRuntimeAction}        
| String        
|  
|-
| Save Data Now        
| The command that saves the current scanpath data into a plain data file.  Assign a filename in the snippets to invoke this command at runtime. The extension of the filename (e.g. .txt, .csv) will define a format of the data file.        
| {s:atRuntimeAction}        
| String        
|  
|-
| Preview Plot        
| Opens a window with the scanpath plot preview. The preview window can be used to visualize a scanpath data file recorded previously.        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| Preview Fixaccade Plot        
| Open a window with the fixaccade plot preview        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Video Results
|-
| Video Capturing        
| Defines whether formation of the plot is captured into a video file.        
| {s:atDesign}        
| Boolean        
|  
|-
| Video Encoder        
| Defines an encoder that will handles video compression for the captured plot video. The selection list contains all video encoders installed in OS, but some might be not compatible for the plot capturing. Make a check run.        
| {s:atDesign}        
| String        
|  
|-
| Configure Encoder        
| Opens a configuration dialog of the selected video encoder, if the encoder supports this option.        
| {s:atDesign}        
| Boolean        
|  
|-
| Frame Rate        
| Defines the frame-rate of the captured video in frame per second. High frame-rates and plot's  rendering size can cause the performance problems or missed frames.        
| {s:atDesign}        
| Int32        
|  
|-
| Output Folder        
| Opens a dialog for selecting a folder to store recorded videos. If no folder is selected, the video will be stored at the location of the experiment file.        
| {s:atDesign}        
| String        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Gaze Processing
|-
| Tracking Device        
| Defines what tracking device provides positional samples for the element. The tracking devices include eye-trackers, the mouse and touch-screens. The 'Auto' option chooses the tracking device selected in the parent event. If there are no tracking elements enabled in the experiment, the system mouse is always used.        
| {s:atDesign}        
| String        
|  
|-
| Sampling Rate        
| Defines the sampling rate of the tracking device  hardware in Hz. Keep the zero value for auto-detection.        
| {s:atNormal}        
| Double        
|  
|-
| Exclusive Thresholds        
| Defines whether the exclusive velocity and saccade duration thresholds are used for the fixation detection 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 saccade duration threshold (in ms.) for the velocity-based detection algorithm. 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 detection algorithm. 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        
|  
|-
| 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>
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
'''Document Analyzer Element''' analyzes eye-tracking or mouse movements over a scrollable formatted document and records a semantic scanpath made of letters, words and paragraphs hit by fixations. The element requires the Rich Text Editor element in non-editable mode coexisting in the same event. <br><br>
{TOC}
Meta Keywords:
Meta Description:
Change Comment:
EventIDE Wiki

Navigation¶

Document Analyzer Element
