OpenViBE Documentation 3.6.0
Display cue image

Summary

  • Plugin name : Display cue image
  • Version : 1.2
  • Author : Joan Fruitet, Jussi T. Lindgren
  • Company : Inria Sophia, Inria Rennes
  • Short description : Display cue images when receiving stimulations
  • Documentation template generation date : Jan 24 2024

Description

Display cue images when receiving specified stimulations. Forwards the stimulations to the AS using TCP Tagging.

Displays different images according to the input stimulations. User can define as many images as needed, with one stimulation associated to each image. A specific stimulation clears the screen.

Inputs

1. Stimulations

Stimulations used to display an image or clear the screen.

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

Outputs

1. Stimulations (deprecated)

The input stimulations are output when the GTK rendering is actually finished (image is displayed or screen is cleared). This output is deprecated.

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

Settings

1. Display images in full screen

Render the images in fullscreen, centered.

  • Type identifier : Boolean (0x2cdb2f0b, 0x12f231ea)
  • Default value : [ false ]

2. Scale images to fit

Scale the images to fit the displayed area.

  • Type identifier : Boolean (0x2cdb2f0b, 0x12f231ea)
  • Default value : [ false ]

3. Clear screen Stimulation

The stimulation that clears the screen to black.

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

4. Cue Image 1

The first image to display.

  • Type identifier : Filename (0x330306dd, 0x74a95f98)
  • Default value : [ ${Path_Data}/plugins/simple-visualization/p300-magic-card/01.png ]

5. Stimulation 1

The stimulation used to display the first image.

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

Examples

The Display Cue Image box can be used to make scenarios that record Event-Related Potentials (ERPs) based on visual events. Use the Lua Stimulator box with a .lua script to create a timeline of stimulations to drive the box (e.g. SSVEP scenarios have examples of such lua scripts). Then, capture the recorded data and events with the Acquisition Client box and feed to Generic Stream Writer.

Miscellaneous

After rendering each image, the Display Cue Image box sends the corresponding stimulations to the Acquisition Server using TCP Tagging.