Programming Reference:VisualStimulus Class

From BCI2000 Wiki
Jump to: navigation, search

Location

src/shared/modules/application/stimuli

Synopsis

VisualStimulus provides a half-way concretization of the abstract Stimulus Class interface for visual stimuli, by defining properties that are common to different kinds of visual stimuli, e.g. textual and image stimuli.

Properties

enum PresentationMode (rw)

This property determines the way a stimulus is presented. It is one of the following:

ShowHide
The stimulus is initially invisible, and visible while being presented.
Intensify
During presentation, the contrast of the stimulus is increased.
Grayscale
During presentation, the stimulus is displayed in grayscale rather than color.
Invert
During presentation, the stimulus appears color-inverted.
Dim
During presentation, the contrast of the stimulus is reduced.
HideShow
The stimulus is initially visible, and invisible while being presented.

float DimFactor (rw)

Determines the contrast ratio between presentation and non-presentation in Dim and Intensify modes. In Intensify mode, values greater 1 will result in a brighter appearance during presentation; in Dim mode, values greater 1 will result in a darker appearance during presentation. Due to saturation effects, the result may not be as expected.

Methods

Present()

Presents the stimulus as specified in the PresentationMode property.

Conceal()

Conceals the stimulus as specified in the PresentationMode property.

See also

Programming Reference:Stimulus Class, Programming Reference:TextStimulus Class, Programming Reference:ImageStimulus Class