Technical Reference:Visualization Properties

From BCI2000 Wiki
Jump to: navigation, search

Visualization properties are properties bound to visualization windows. Currently, the following visualization properties are defined:

Window Properties

Top, Left, Width, Height (number)

Position and size of the visualization window on the virtual desktop.

WindowTitle (string)

The visualization window's title.

Visible (boolean)

Whether the window is visible or not.

Graph Options

MinValue, MaxValue (number)

The minimum and maximum expected signal value in Microvolts. This value is used to determine the signal's default scaling.

NumSamples (number)

The number of samples displayed in the visualization window.

ChannelGroupSize (number)

The number of subsequent channels that share a common signal baseline.

GraphType (number)

Polyline or Field2d. Polyline stands for the standard multi-channel signal view, while Field2d defines a two-dimensional field with color-encoded values.

ShowBaselines (boolean)

For a Polyline display, switches baselines on or off.

ChannelColors (list of hex values)

For a Polyline display, defines the list of colors to be used for drawing signals. The list is enclosed in curly braces as in { 0xff0000, 0x00ff00, 0x0000ff }.

Units

SampleUnit (string)

The difference between two subsequent sample positions, given as a number followed by a unit, such as 1.4ms. This is used to display units on the x axis of the visualization window.

ChannelUnit (string)

If the channel dimension is a continuous variable, then this property gives the difference between two subsequent channels, as a number followed by unit, such as 2Hz. This is used to display units on the y axis of the visualization window, and currently only used with Field2d type graphs.

ValueUnit (string)

The value of one unit for the values displayed in a visualization window, such as 2muV. This property is used to display value units in Polyline type graphs.

Memo Options

NumLines (number)

The number of lines in a visualization window of type "memo".

Label Lists

ChannelLabels (list of strings)

A list of strings specifying channel labels. Channel labels are displayed to the left of channel traces in Polyline graphs.

GroupLabels (list of strings)

A list of strings specifying a label for each channel group. Channel groups consist of a number of channels displayed on a single baseline.

XAxisLabels (list of {number,string} pairs)

A list of position, label pairs that define labels on the X axis.

YAxisLabels (list of {number,string} pairs)

A list of position, label pairs that define labels on the Y axis.

Marker Lists

XAxisMarkers (list of numbers)

A list of positions at which to display marker lines on the X axis.

YAxisMarkers (list of numbers)

A list of positions at which to display marker lines on the Y axis.

Miscellaneous

ShowSampleUnit (boolean)

Switches sample unit display on or off for graphs.

ShowChannelUnit (boolean)

Switches channel unit display on or off for Field2d graphs.

ShowValueUnit (boolean)

Switches value unit display on or off for Polyline graphs.

SampleOffset (number)

An offset, in raw units, which to add to the displayed values on the X axis.

InvertedDisplay (boolean)

Switches between white-on-black and black-on-white display for Polyline graphs.

See also

User Reference:Operator Module Scripting