PsyPhy Signal Element

Modified on 2024/11/28 19:05 by Administrator Categorized as Elements, Signal Acquisition
<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=PsyPhy Signal
| category=Signal Acquisition
| icon=[image|Element Icon|{UP(PsyPhy-Signal-Element)}PsyPhy-Signal-Element-Icon.png]
| author= OkazoLab
| addin= PsyPhy AddIn
| scope= Experiment
| usage= Snippets
| ownsnippets= None
}
== Properties ==
{|
|-
! Name
! Description                              
! Constraints
! Type
! On<br/>runtime<br/>change
|-
| colspan="5" bgcolor="#AADDDDD" | PsyPhy Settings
|-
| PsyPhy IP        
|          
| {s:atDesign}        
| String        
|  
|-
| Sampling Rate        
| Defines the sampling rate of the PsyPhy amplifier        
| {s:atDesign}        
| Int32        
|  
|-
| Network Protocol        
| Defines the network protocol for streaming from the PsyPhy amplifier        
| {s:atDesign}        
| Int32        
|  
|-
| Channel Settings        
| Opens a window with the PsyPhy channel settings        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| Check Impedance Now        
| Opens a window showing the current impedance value        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| Sample Type        
| Defines the type (raw or calibrated) of recorded samples        
| {s:atDesign}        
| Int32        
|  
|-
| WiFi Strength        
| Defines a relative strength of the WiFi signal generated by the amplifier. Weaker WiFi signal may reduce EEG interferences.        
| {s:atNormal}        
| Int32        
|  
|-
| Impedance Range        
| Defines a range for the normalization of the impedance values in kOhm to the red-Green color gradient on the impedance plot        
| {s:atNormal}        
| clRange        
|  
|-
| XAML Impedance Plot        
| Returns a live XAML plot showing a map of impedance scores per electrode. The plot can be used for direct binding to the Content property of the XAML ContentControl element, e.g. <ContentControl Content='{Binding XAMLSignalPlot}'/> The ContentControl with a generated plot can be shown on the status screen or by the XAML Layout element.        
| {s:atNormal}        
| UIElem..        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Runtime Control
|-
| Reconnect Now        
| Runtime command that reconnects the amplifier and resumes the recording        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| Missed samples        
| Returns a total number of missed samples for the current recording        
| {s:atDesign}        
| UInt64        
|  
|-
| Reset Signals Now        
| Runtime commands that resets the signal buffers and data acquisition        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Signal Generator
|-
| Signal Generator        
| Defines whether signal samples are produces by an oscillatory generator rather than the actual hardware. You can use the signal generator for test runs without hardware        
| {s:atDesign}        
| Boolean        
|  
|-
| Emulated Sampling Rate        
| Defines the emulation sampling rate (samples per second), when data is generated or streamed from a file.        
| {s:atDesign}        
| Double        
|  
|-
| Primary Frequency        
| Defines the frequency of the primary rhythm in the generated signal, in Hz. Assign the zero to exclude the primary frequency from the generated signal.        
| {s:atDesign}        
| Double        
|  
|-
| Secondary Frequency        
| Defines the frequency of the secondary rhythm in the generated signal, in Hz. The secondary frequency magnitude is a half of the primary frequency magnitude. Assign the zero to exclude the secondary frequency from the generated signal.        
| {s:atDesign}        
| Double        
|  
|-
| Noise Level        
| Defines the noise level (in % to the norm magnitude of the primary frequency). The noise is added to the generated signal. Assign the zero the exclude the noise from the generated signal.        
| {s:atDesign}        
| Double        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Channel Configuration
|-
| Selected Channels        
| Defines what signal channels are selected for acquisition within EventIDE. Selected channels are registered in the EventIDE signal pool at runtime and become available for the signal analysis elements.        
| {s:atDesign}        
| List`1        
|  
|-
| Selected Channel Count        
| Indicates how many signal channels are currently selected for acquisition        
| {s:atStatus}        
| Int32        
|  
|-
| Total Channel Count        
| Indicates how many signal channels are available for acquisition in the total        
| {s:atStatus}        
| Int32        
|  
|-
| Buffer Size        
| Defines the size (in samples) of a circular buffer that stores incoming signal data.        
| {s:atDesign}        
| Int32        
|  
|-
| 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 element runs real-time signal acquisition with the PsyPhy amplifier made by [https://psyphy.io/|PsyPhy BV]
{TOC}

== Description ==

The element allowing connecting one or more PsyPhy amplifiers, selected channels, check the electrode impedance and run real-time signal acquisition at the background of an experimental task. The singal then can be used for online processing, visualization and timestammped recording with other elements in EventIDE,

== Practical Use ==

=== Preparing the element for the first use ===

# Add PsyPhy Signal element to the global elements in your experiment and select it.
# In the Properties panel, enter the IP address of the connected amplifer, select the sampling rate and network protocol.
# Chose amplifer channels for acquisition via the 'Selected Channels' property.
# If required, configure the amplifer channels via the 'Channel Settings' property.
# If the amplifier and electrodes are connected, you can check the electrode impedance before running the expeirment, via the 'Check Impedance Now' property.

=== Notes ===

* The element offers 2 network protocals for a PsyPhy connection: TCP and UDP. The UPD protocal can have a shorter transmission latency but makes larger processor load and potentially can lose some signal samples. Unless it is required by your task, the TCP protocal is recommended.
Meta Keywords: EEG, PsyPhy, Signal Acquisition
Meta Description:
Change Comment:
EventIDE Wiki

Navigation¶

PsyPhy Signal Element
