OpenViBE Documentation 3.6.0
Signal Concatenation

Summary

  • Plugin name : Signal Concatenation
  • Version : 2.0
  • Author : Laurent Bonnet
  • Company : INRIA
  • Short description : Concatenates multiple signal streams
  • Documentation template generation date : Jan 24 2024

Description

The signal stream concatenation box reads multiple streams in parallel, and produces a single stream that is the concatenation of all inputs.

The input streams must share the same characteristics : sampling frequency, number of channels, sample count per block.
User can specify a time-out value beyond which a stream is considered as finished if no samples are received.
If user wants a specific part of a given stream, he can specify a stimulation used as end-of-stream trigger.

The status stimulation output deliver the stimulation OVTK_StimulationId_EndOfFile when the concatenation is finished. You can connect this output to a BoxAlgorithm_PlayerController to script your concatenation easily.

Inputs

The box has a pair of input (signal, stimulation) per source.

1. Input signal 1

Signal stream from source #1.

  • Type identifier : Signal (0x5ba36127, 0x195feae1)

2. Input stimulations 1

Stimulation stream from source #1.

  • Type identifier : Stimulations (0x6f752dd0, 0x082a321e)

3. Input signal 2

Signal stream from source #2.

  • Type identifier : Signal (0x5ba36127, 0x195feae1)

4. Input stimulations 2

Stimulation stream from source #2.

  • Type identifier : Stimulations (0x6f752dd0, 0x082a321e)

Outputs

1. Signal

Concatenated signal stream.

  • Type identifier : Signal (0x5ba36127, 0x195feae1)

2. Stimulations

Concatenated stimulation stream.

  • Type identifier : Stimulations (0x6f752dd0, 0x082a321e)

3. Status

Status stimulation stream (sends OVTK_StimulationId_EndOfFile on success).

  • Type identifier : Stimulations (0x6f752dd0, 0x082a321e)

Settings

A stimulation setting is added for each input pair.

1. Time out before assuming end-of-file (in sec)

If no samples are received beyond this time-out value, a stream is considered as finished.

  • Type identifier : Integer (0x007deef9, 0x2f3e95c6)
  • Default value : [ 5 ]

2. End-of-file stimulation for input 1

Stimulation that triggers the end-of-stream for source #1.

  • Type identifier : Stimulation (0x2c132d6e, 0x44ab0d97)
  • Default value : [ OVTK_StimulationId_ExperimentStop ]

3. End-of-file stimulation for input 2

Stimulation that triggers the end-of-stream for source #2.

  • Type identifier : Stimulation (0x2c132d6e, 0x44ab0d97)
  • Default value : [ OVTK_StimulationId_ExperimentStop ]

Examples

This box is mainly designed to concatenate multiple signal files.
For example, you have 10 sessions of training and you want to train a classifier on the whole set of data.
You can use the Signal Stream Concatenation to produce one EEG file containing the 10 sessions,
and then feed a Classifier trainer box with it.

Miscellaneous