Summary
|
BioGraph Signal
|
| Info |
| Category: |
Signal Acquisition |
|
AddIn: |
Signal Processing |
| Creator: |
OkazoLab |
|
Scope: |
Experiment |
| Owns Snippets: |
None |
|
Usage: |
Snippets |
Properties
| Name | Description | Constraints | Type | On
runtime
change |
|---|
| Biograph Server |
| Biograph Server Address | Defines the address of a computer on which the Biograph server is running. Use '127.0.0.1', if the Biograph server runs on the same computer. | | String | |
| Biograph Port Number | Defines the port number of the Biograph server | | Int32 | |
| Sampling Rate | Defines the requested sampling rate (in Hz) of the Biograph server | | Double | |
| Action Channel Info |
| Update Channel Info Now | Assign 'true' at the runtime, to update the channel info by code | | Boolean | |
| Channel Type | Returns an array of action channels types from the current configuration of the Biograph server. | | cxcAct.. | |
| Threshold1 | Returns a double array of the thresholds 1 from the current configuration of the Biograph server. | | Double.. | |
| Threshold2 | Returns a double array of the thresholds 2 from the current configuration of the Biograph server. | | Double.. | |
| Scale Minimum | Returns a double array of the signal scale minimums from the current configuration of the Biograph server. | | Double.. | |
| Scale Maximum | Returns a double array of the signal scale maximums from the current configuration of the Biograph server. | | Double.. | |
| Signal Generator |
| Signal Source | Defines a source for the signal. The emulated rhythmes can be used for offline validation of the chosen analysis settings | | enEmul.. | |
| Emulated Sampling Rate | Defines the emulation sampling rate (samples per second), when data is generated or streamed from a file. | | 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. | | 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. | | 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. | | Double | |
| External Datafile | Opens 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 | |
| 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. | | IList | |
| Selected Channel Count | Indicates how many signal channels are currently selected for acquisition | | Int32 | |
| Total Channel Count | Indicates how many signal channels are available for acquisition in the total | | Int32 | |
| Buffer Size | Defines the size (in samples) of a circular buffer that stores incoming signal data. | | Int32 | |
| Runtime Control |
| Reset Signals Now | Runtime commands that resets the signal buffers and data acquisition | | Boolean | |
| Control |
| Is Enabled | If set to false the element is completely omitted when the experiment is run | | Boolean | |
| Title | Title of the element | | String | |
|
BioGraph Signal 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.
Description
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
- Make use that the Biograph server application is operational and connected to the EventIDE computer by a network (or, runs on the same computer).
- 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).
- Select the new Biograph Signal element and browse its properties in the Property panel.
- Set the Biograph Server Address and Biograph Port Number properties, if necessary.
- Select the channels for acquisition and buffering via the Selected channels property.
- Update the Action Channels Info by requesting the Biograph configuration with the Update Channel Info action
- Once the channels are selected, you can access them with by of the signal processing elements.
Notes
- 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.