Welcome Guest, you are in: Login

EventIDE Wiki

RSSRSS

Navigation




Search the wiki


PoweredBy

Phase Locker Element

RSS
Modified on 2024/09/16 22:27 by Administrator Categorized as Elements, Signal Processing

Summary

Element Icon Phase Locker
Info
Category: Signal Processing AddIn: Phase Locking
Creator: OkazoLab Scope: Parent event
Owns Snippets:   Triggered Usage: Snippets

Properties

NameDescription                              ConstraintsTypeOn
runtime
change
Control
Title        Title of the element                String         
Is Enabled        If set to false the element is completely omitted when the experiment is run                Boolean         
Signal Source
Sampling Rate        Defines the sampling rate of the input signal in samples per second                Int32         
Input Channel        Defines the channel in the EventIDE signal pool that will provides data for the element                Int32         
Signal Modeling
Analysis Window Length        Defines a time length of the analysis moving window of the input signal, in seconds                Double         
Model Period        Defines a length of the model segment in periods of the central frequency of interest. The segment is aligned to the end of the analysis window.                Double         
Brain Wave Preset        Defines the preset ROI ranges for the most common brain rhymes                Int32         
Frequency Range        Defines 'the range of interest' for phase locking and PSD stats on the Session Statistics plot.                clRange         
Forecast Period        Defines a length of the forecasted segment ('future signal') in periods of the central frequency of interest                Double         
NLF Iterations        Defines the maximal number of iterations in the non-linear fitting                Int32         
Prediction Statistics
Store model/signal samples        Defines whether the samples of the input signal and the fitted models are stored in the prediction list data file                Boolean         
Session Stats Tick        Defines a tick interval for updating the session statistics plot                String         
Phase Locking
Target Phase        Defines sine phases (in degrees) that need to be predicted in the forecasted signal. To define more than one phase, enter values with delimiters (' ','|' or ';')                String         
Is Presenting        Defines whether the stimulus presentation mode is enabled. In that presentation mode, the element gets triggered at the time of the target phase and calls the triggered snippet. In turn, the latter can be used to present a stimulus or to run user events.                Boolean         
Presentation Mode        Defines a stimulus sequence when the stimulus presentation mode is enabled. If the 'Single presentation' is selected, the stimulus presentation mode is automatically switched off after the first presentation. If 'Sequential presentation' is selected, the stimuli are presented until the stimulus presentation mode is turned off manually.                Int32         
Prehold Number        Defines the number of prehold presentations (within the max prehold interval) required before the element is triggered for a real phase-locked stimulus presentation. Using this property may help in preventing stimulus presentations on incidental oscillations."                Int32         
Max Prehold Interval        Defines the maximum time interval (in milliseconds) between two potential presentations, counted in relation to the Prehold Number. If the value is zero, the property is ignored. Otherwise, the Prehold counter resets if the time interval exceeds the specified property value.                Double         
Thresholds
Power Threshold        Defines the minimal threshold for a power of the dominant frequency that allows the phase prediction.                Double         
Residual Error Threshold        Defines the minimal threshold for the normalized residual error (MAE)                Double         
ACF Threshold        Defines the minimal threshold for the ACF error                Double         
Model Correlation Threshold        Defines the minimal threshold for the normalized phase fitting error                Double         
Minimal Amplitude Threshold        Defines the minimal allowed peak amplitude for the fitting segment. Since the algorithm works with a non-normalized input signal, the threshold value must be found empirically. If the zero value is set, this threshold is ignored.                Double         
Maximal Amplitude Threshold        Defines the maximal allowed peak amplitude for the fitting segment. Since the the algorithm works with a non-normalized input signal, the threshold value must be found empirically. If the zero value is set, this threshold is ignored.                Double         
Crunch Time
Hardware Lag        Defines a time lag in signal acquisition. When the lag is measured empirically the value should be defined manually. When auto correction is enabled, the lag is estimated automatically.                Double         
Auto Crunch Times        Defines whether the target phase is automatically shifted in order to compensate the hardware lag. If the mode is on the hardware lag does not included in the crunch time                Boolean         
Smart Phase Mode        Defines whether the target phase is automatically shifted in order to compensate the hardware lag. If the mode is on the hardware lag does not included in the crunch time                Boolean         
Min Crunch Time        Defines the lower bound for a period of future time (ms), in which prediction of the target phase can be made. If the target phase is expected earlier in time, the prediction is dismissed. The min crunch time must be less than the max crunch time and greater than the hardware lag plus the analysis time                Double         
Max Crunch Time        Defines the upper bound for a period of future time (ms), in which prediction of the target phase can be made. If the target phase is expected later in time, the prediction is dismissed. The max crunch time must be greater than he min crunch time and less than the length of the modeled signal                Double         
Min Prediction Interval        Defines a minimal time interval (ms) between two consecutive predictions                Double         
Runtime Status
Is Triggered        Indicates whether the elements signal the predicted phase occurrence in real-time. This status variable can be used for accurate phase-locked stimulus presentation                Boolean         
Triggering Time        Returns a local event time (ms) of the last triggering.                clTime         
Current Lock Phase        Returns the currently expected phase among all target phases                Double         
XAML Dashboard        Returns a live XAML control that can be used online monitoring and parameter adjustments on the status screen                UIElem..         

The element allows locking stimulus presentation or user events to selected phases of a real-time oscillatory signal. The element provides essential configuration settings, which are suitable for the most scenarios. For very advanced phase-locking protocols, you can use the Pro version of this element.

Description

...

Snapshots

Snapshot 1

Snapshot 1

Snapshot 2

Snapshot 2

Practical Use

...

Technique 1

  1. Step 1
  2. Step 2
    ...
    === Technique 2 ===
  3. Step 1
  4. Step 2
    ...

     // Check the trial outcome. Result and RT just other user variables
    
    // insert code snippet here..
               
    ...
    == Notes ==
    ...
  5. Insert Notes here..
  6. Insert Notes here..

 
  Name Size
- Phase-Locker-Element-Icon.png 3.79 KB

ScrewTurn Wiki version 5.2.0.8. Some of the icons created by FamFamFam.