Welcome Guest, you are in: Login

ScrewTurn Wiki



Search the wiki

Element Icon TMSi Signal Element
Category: Signal Acquisition AddIn: Signal Processing
Creator: OkazoLab Team Scope: Global
Owns Snippets: no Usage: Processing

Element's actions aligned with epochs of the experiment

Experiment OnsetThe element starts data acquisition and buffering.
Control Loop stepThe element buffers newly received samples
Experiment OffsetThe element stops data acquisition and buffering.


Generic Properties

NameDescriptionConstraintsValue TypeUpon Runtime Change
TMSi Settings
Requested Sampling RateDefines the desired sampling rate (samples per second) of EEG amplifier. If the value is not supported the hardware sets the default rate.Int32
Actual Sampling RateReturns the actual sampling rate of EEG amplifier. The value is updated on the startup of the experiment.Double

+=== Properties inherited from the base signal provider element === Inherited properties of the Signal Provider Element
Channel Configuration
Selected ChannelsDefines 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.IList
Selected Channel CountIndicates how many signal channels are currently selected for acquisition.Int32
Total Channel CountIndicates how many signal channels are available for acquisition in the total.Int32
Buffer SizeDefines the size (in samples) of a circular buffer that stores incoming signal data.Int32
Signal Generator
Signal SourceDefines a source for the signal. The emulated rhythmes can be used for offline validation of the chosen analysis settingsenum
Emulated Sampling RateDefines the emulation sampling rate (samples per second), when data is generated or streamed from a file.Int32
Primary FrequencyDefines the frequency of the primary rhythm in the generated signal, in Hz. Assign the zero to exclude the primary frequency from the generated signal.Double
Secondary FrequencyDefines 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.Double
Noise LevelDefines 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.Double
External DatafileOpens the dialog for selecting a data file containing a stream of double numbers representing a signal. If a file name without a path is defined, the data file will be picked up in the location of the experiment file.String

+=== Properties inherited from clElement === Inherited properties of clElement
NameDescriptionConstraintsValue TypeUpon Change
Is EnabledIf set to false the element is completely omitted when the experiment is run.Boolean
TitleTitle of the element.String

The element allows real-time signal acquisition with TMSi EEG amplifiers and QuickAmp amplifiers by Brain Products


The TMSi Signal element is capable of reading an EEG signal conveyed through EEG hardware supporting the TMSi protocol. As an experiment starts, the element begins receiving data and buffering samples into circular buffers, maintained by EventIDE (the buffers can collect data from multiple signal acquisition elements). The signal processing elements, e.g. Signal Analyzer element can be then used to monitor and analyze the buffered signals at runtime. Fast buffering and processing time in EventIDE (down to 1ms) allows instant detection of signal characteristics and, subsequently, various forms of signal-based feedback control in experiment.

Practical Use

  1. Add a new TMSi Signal element to any event in your experiment (the element is global and works from the start to the end of experiment).
  2. Select the added element to browse its properties in the Property panel.
  3. Sets the desired sampling rate via the corresponding property. Use only values supported by your EEG hardware. The actual sampling rate will be returned by the Actual Sampling Rate property after the start of experiment.
  4. Select the channels for acquisition and buffering within EventIDE via the Selected channels property.
  5. Use the signal processing elements to access the buffered data.


  • The element requires the TMSi driver of the version 7 and above

  Name Size
- TMSiIcon.png 5.30 KB

ScrewTurn Wiki version Some of the icons created by FamFamFam.