Welcome Guest, you are in: Login

ScrewTurn Wiki



Search the wiki

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

Element actions aligned with different epochs of the parent event

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
Biograph Server
Biograph Server AddressDefines the address of a computer on which the Biograph server is running. Use '', if the Biograph server runs on the same computer.String
Biograph Port NumberDefines the port number of the Biograph serverInt32
Action Channel Info
Update Channel InfoInvoke this action to request the current configuration of the Biograph server (the server must be run). The configuration values, e.g. channel types, are returned by other Action Channel Info properties. At run-time, the configuration is updated automatically, however, you can assign 'true' to this property to update the channel info at will.Boolean
Channel TypeReturns an array of action channels types in the current configuration of the Biograph server.enum array
Threshold 1Returns a double array of the thresholds 1 in the current configuration of the Biograph server.Double[]
Threshold 2Returns a double array of the thresholds 2 in the current configuration of the Biograph server.Double[]
Channel MinimumReturns a double array of the signal minimums in the current configuration of the Biograph server.Double[]
Channel MaximumReturns an array of the signal maximums from in current configuration of the Biograph server.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 Biograph element reads and buffers real-time signals provided by the Biograph server application, which, in turn, collects and pre-processes data from various bio-sensor hardware Thought Technology Ltd. The Biograph server can be run either in parallel with EventIDE, or on a separate computer in a network.


The Biograph element reads arbitrary signals sent via a network by the Biograph server application. The signals conveys so-called 'Biograph actions', which may include binary, percentage or numerical values depending on the signal type. Up to 64 signals can be processed in parallel. As an experiment starts, the element begins receiving data and buffering signal samples into circular buffers, maintained by EventIDE (the buffers can collect data from multiple signal acquisition elements) at the fixed rate of 16Hz. The signal processing elements, e.g. Signal Analyzer element can be then used to monitor and analyze the buffered signals at run-time. Fast buffering and processing time in EventIDE allows instant detection of signal characteristics and, subsequently, various forms of signal-based feedback control in experiments.

Practical Use

  1. Make use that the Biograph server application is operational and connected to the EventIDE computer by a network (or, runs on the same computer).
  2. Add a new Biograph Signal element to any event in your experiment (the element is global and works from the start to the end of experiment).
  3. Select the new Biograph Signal element and browse its properties in the Property panel.
  4. Set the Biograph Server Address and Biograph Port Number properties, if necessary.
  5. Select the channels for acquisition and buffering via the Selected channels property.
  6. Update the Action Channels Info by requesting the Biograph configuration with the Update Channel Info action
  7. Once the channels are selected, you can access them with by of the signal processing elements.


  • Reading the Biograph signals performs in the main Control Loop of an EventIDE experiment. If the control loop interval exceeds 62.5 ms (e.g. during heavy graphical updates), some data samples can be lost. Normally, the control loop interval stays within 1ms, which is safe for loosless signal reading.

  Name Size
- BiographIcon.png 4.39 KB

ScrewTurn Wiki version Some of the icons created by FamFamFam.