Module: visualization

Visualization nodes.

These nodes generally open new plotting windows and display the data that is received by the node. Most of these nodes are meant for real-time visualization.

BarPlot

Plot data in a realtime bar chart.

For streaming data only.

Version 1.0.2

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • stream_name
    Name of stream to display. The first stream whose name starts with this string is displayed. Otherwise, the first signal stream is selected.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • axis
    Axis from which to extract bar labels.

    • verbose name: Axis
    • default value: feature
    • port type: EnumPort
    • value type: object
  • instance_field
    If the axis containing labels is the instance axis, specify the instance.d ata field containing the label.

    • verbose name: Instance Field
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • use_last_instance
    If the packet received contains multiple samples along the instance axis, and the instance axis is not the one being plotted (in the axis property), then select the last sample for plotting.

    • verbose name: Use Last Instance
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • title
    Figure title and identifier.

    • verbose name: Title
    • default value:
    • port type: StringPort
    • value type: str (can be None)
  • background_color
    Background color. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Background Color
    • default value: #FFFFFF
    • port type: StringPort
    • value type: str (can be None)
  • bar_width
    Bar width.

    • verbose name: Bar Width
    • default value: 0.33
    • port type: FloatPort
    • value type: float (can be None)
  • bar_color
    Bar color.

    • verbose name: Bar Color
    • default value: b
    • port type: StringPort
    • value type: str (can be None)
  • y_limits
    Upper and lower limits of the bar plot.

    • verbose name: Y Axis Plot Limits
    • default value: [-50, 50]
    • port type: ListPort
    • value type: list (can be None)
  • label_rotation
    Orientation of plot tick labels.

    • verbose name: Label Rotation
    • default value: vertical
    • port type: EnumPort
    • value type: object (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and is formatted as [x, y, width, eight]. If x, y are set to 0 each, then the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 700, 500]
    • port type: ListPort
    • value type: list (can be None)
  • always_on_top
    Window should be always on top. If this is enabled, then the window will not be occluded by other windows.

    • verbose name: Always On Top
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • show_toolbar
    Whether to show the window toolbar.

    • verbose name: Show Toolbar
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • verbose
    Enable verbose output.

    • verbose name: Verbose
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

ConnectivityPlot

Plot estimated connectivity / directed or undirected information flow between 3d regions of interest (ROIs) in brain source space.

This node accepts a connectivity measure, estimated by one of the nodes in the connectivity category and plots the most recent time point in the data. The rendering is done as a graph of spherical nodes for the regions, connected by conical edges according to the flow direction and strength. The data is expected to have two space axes to store the all-to-all connectivity between ROIs. This node also provides keyboard shortcuts for changing the color scale (+ and -). Note that this plotter is not meant for offline review of a whole dataset.

Version 0.9.6

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • stream_name
    Name of stream to display. The first stream whose name starts with this string is displayed.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • headmodel
    Headmodel file to use. If not given, this node will look in the 'headmodel' property of the data, which would usually be written by the initial sourc estimation node in your pipeline.

    • verbose name: Override Headmodel Filename
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • colormap
    Colormap to use for plotting activity.

    • verbose name: Activity Colormap
    • default value: Bipolar
    • port type: EnumPort
    • value type: object (can be None)
  • title
    Title of the plot. This is the title of the plot window.

    • verbose name: Title Of Plot Window
    • default value: Time series view
    • port type: StringPort
    • value type: str (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and is expressed as [x, y, width, height]. If x, y are both set to 0, the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 700, 500]
    • port type: ListPort
    • value type: list (can be None)

CortexActivityPlot

Plot estimated brain source activity on a 3d model of a brain in real time.

This node accepts a multi-channel time series, possibly segmented, and always plots the most recent sample. The data is expected to have one channel for every vertex in the head model used for plotting, which can be achieved by using one of the source localization nodes to estimate the source activity (using the same headmodel). This node also provides keyboard shortcuts for changing the color scale (+ and -). Note that this plotter is not meant for offline review of a whole dataset.

Version 0.9.2

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • stream_name
    Name of stream to display. The first stream whose name starts with this string is displayed.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • headmodel
    Headmodel file to use. If not given, this node will look in the 'headmodel' property of the data, which would usually be written by the initial sourc estimation node in your pipeline.

    • verbose name: Override Headmodel Filename
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • colormap
    Colormap to use for plotting activity.

    • verbose name: Activity Colormap
    • default value: Bipolar
    • port type: EnumPort
    • value type: object (can be None)
  • colorscale
    Intensity scale for brain activity.

    • verbose name: Color Scale
    • default value: 0.0001
    • port type: FloatPort
    • value type: float (can be None)
  • title
    Title of the plot. This is the title of the plot window.

    • verbose name: Title Of Plot Window
    • default value: Time series view
    • port type: StringPort
    • value type: str (can be None)
  • background_color
    Background color. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Background Color
    • default value: #FFFFFF
    • port type: StringPort
    • value type: str (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and expressed as [x, y, width, height]. If x, y are both set to 0, the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 700, 500]
    • port type: ListPort
    • value type: list (can be None)
  • showlogo
    Flag to show the intheon logo.

    • verbose name: Show Logo
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

HeadPlot

Plot EEG channel activity on a 3d model of a head in real time.

This node accepts a multi-channel time series, possibly segmented, and always plots the most recent sample. The data is expected to have a space axis with 3d locations for each channel, and the signal in these channels is smoothly mapped onto the scalp using an interpolation. This node also provides keyboard shortcuts for changing the color scale (+ and -). Note that this plotter is not meant for offline review of a whole dataset.

Version 0.9.0

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • headmodel
    Headmodel file to use. If not given, this node will look in the 'headmodel' property of the data, which would usually be written by the initial sourc estimation node in your pipeline.

    • verbose name: Headmodel Filename
    • default value:
    • port type: StringPort
    • value type: str (can be None)
  • stream_name
    Name of stream to display. The first stream whose name starts with this string is displayed.

    • verbose name: Select Stream To Display
    • default value:
    • port type: StringPort
    • value type: str (can be None)
  • colormap
    Colormap to use for plotting activity.

    • verbose name: Activity Colormap
    • default value: Bipolar
    • port type: EnumPort
    • value type: object (can be None)
  • colorscale
    Intensity scale for scalp activity.

    • verbose name: Color Scale
    • default value: 0.0001
    • port type: FloatPort
    • value type: float (can be None)
  • sigma
    Standard deviation of the the Gaussian interpolation kernel.

    • verbose name: Sigma
    • default value: 0.01
    • port type: FloatPort
    • value type: float (can be None)
  • title
    Title of the plot. This is the title of the plot window.

    • verbose name: Title Of Plot Window
    • default value: Head-space view
    • port type: StringPort
    • value type: str (can be None)
  • background_color
    Background color. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Background Color
    • default value: #FFFFFF
    • port type: StringPort
    • value type: str (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and is formatted as [x, y, width, eight]. If x, y are set to 0 each, then the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 700, 500]
    • port type: ListPort
    • value type: list (can be None)
  • only_signals
    Apply only to signal chunks. If unset, the first chunk with any numeric data will be displayed. Default: True.

    • verbose name: Only Signals
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

InspectData

Creates a plot with three tables showing: 1) matrix or vector of values from a data stream based on the axes selected in the properties; 2) a list of the axes in the stream and their values; 3) a list of the streams in the packet and their shape and properties.

This is a more legible replacement for the PrintToConsole in cases where windows can pop up. It can be particularly helpful when debugging a pipeline in order to see what the data is like at a given point.

Version 2.1.1

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • show_data_table
    Show table containing data from the col/row axes selected here.

    • verbose name: Show Data Table
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • show_axes_table
    Show table with a list of the axes in the stream and their values.

    • verbose name: Show Axes Table
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • show_streams_table
    Show table with a list of the streams in the packet, and their properties.

    • verbose name: Show Streams Table
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • show_markers_table
    Show table with a list of the streams in the packet, and their properties.

    • verbose name: Show Markers Table
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • stream_name
    Name of stream to display. If empty, the first stream of signal data will be displayed. When used with streaming data, a dropdown box will appear allowing you to switch streams as the pipeline is running. When used with offline data, only a single stream will be shown, so change the stream name here to see a particular stream.

    • verbose name: Stream Name
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • col_axis
    Axis to use for the column data in the data table. If none, a single column will be shown with the data from the row axis.

    • verbose name: Col Axis
    • default value: time
    • port type: EnumPort
    • value type: object (can be None)
  • row_axis
    Axis to use for the rows data, in the data table. If none, a single row will be shown with the data from the column axis.

    • verbose name: Row Axis
    • default value: space
    • port type: EnumPort
    • value type: object (can be None)
  • decimals
    Number of decimal points to round data to (applies to data table only).

    • verbose name: Decimals
    • default value: 6
    • port type: IntPort
    • value type: int (can be None)
  • show_max_columns
    Only show the first X columns (X being the value input here. Set to 0 to show all columns. Warning: Showing all columns on offline data will likely cause the plot to take a long time to come up.

    • verbose name: Show Max Columns
    • default value: 20
    • port type: IntPort
    • value type: int (can be None)
  • show_max_values
    Only show the first X values in an axis. This is to avoid the plot becoming slow when handling offline data with very long axes (such as many timepoints). Set to 0 to show all values. Is automatically set to 0 for streaming data (since this is not an issue).

    • verbose name: Show Max Values
    • default value: 50
    • port type: IntPort
    • value type: int (can be None)
  • every_n_ticks
    Show data only every N ticks. This slows down the display of data (which by default runs at 25Hz). This is only applicable to streaming data and mostly useful for the data table. Setting this to > 1 is not recommended if looking at the Marker table as most markers would not be shown.

    • verbose name: Every N Ticks
    • default value: 1
    • port type: IntPort
    • value type: int (can be None)
  • window_title
    Set the window title.

    • verbose name: Window Title
    • default value: Inspect Data Packet
    • port type: StringPort
    • value type: str (can be None)
  • font_size
    Font size for table data.

    • verbose name: Font Size
    • default value: 10
    • port type: IntPort
    • value type: int (can be None)
  • always_on_top
    Window should be always on top.

    • verbose name: Always On Top
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • fewer_buttons
    Do not show a minimize and maximize buttons on the window (to give more space for the window title). The window will still have a close button.

    • verbose name: Fewer Buttons
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • initial_position
    Initial position of the window on the screen. This is given in pixels, and is formatted as [x, y, width, height], where x=0 and y=0 represent the top left corner.

    • verbose name: Initial Position
    • default value: [20, 50, 500, 400]
    • port type: ListPort
    • value type: list (can be None)
  • auto_close
    Automatically close the window when the pipeline finishes. When False, the window will stay open when the pipeline ends (you can then close the window yourself).

    • verbose name: Auto Close
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

MarkerStreamWindow

Create a basic text window to display markers and times as they come in.

This is ideal for validating your live stream and checking that markers are still being sent .

Version 1.0.1

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • stream_name
    Name of stream to display. The first stream whose name starts with this string is displayed.

    • verbose name: Select Stream To Display
    • default value: Markers
    • port type: StringPort
    • value type: str (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and is formatted as [x, y, width, eight]. If x, y are set to 0 each, then the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 500, 500]
    • port type: ListPort
    • value type: list (can be None)
  • always_on_top
    Window should be always on top. If this is enabled, then the window will not be occluded by other windows.

    • verbose name: Always On Top
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • override_srate
    Optionally override sampling rate.

    • verbose name: Override Srate
    • default value: None
    • port type: FloatPort
    • value type: float (can be None)

ScrollPlot

Plot a multi-channel continuous time series in a scrollable plot offline.

This node accepts a full length data set using an adjustable window size. The node requires that the data has a time axis, and either a space (channels) or a feature axis. All other axes (e.g., frequency) are folded into a flat space axis. For better viewing, this node supports removing the mean of the data so that the signals are centered and can autoscale the values. These options are enabled by default. To remove drift or a DC offset it is recommended to use a high-pass filter before using this node. This node also provides keyboard shortcuts for changing the scale (+ and -) as well as scrolling through the plot (left and right arrows, page down and up).

Version 1.0.0

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • stream_name
    Name of stream to display. The first stream whose name starts with this string is displayed.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • scale
    Data scale. Increasing this value will magnify the plot curves correspondingly.

    • verbose name: Data Scaling
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)
  • time_range
    Time range to display. This is the number of seconds of recent data that shall be plotted.

    • verbose name: Time Range To Display
    • default value: 5.0
    • port type: FloatPort
    • value type: float (can be None)
  • title
    Title of the plot. This is the title of the plot window. Placeholders like $(streamname) or $(sourceid) can be used here.

    • verbose name: Title Of Plot Window
    • default value: Time series view
    • port type: StringPort
    • value type: str (can be None)
  • background_color
    Background color. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Background Color
    • default value: #FFFFFF
    • port type: StringPort
    • value type: str (can be None)
  • line_color
    Color of the graph curves. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Line Color
    • default value: #000000
    • port type: StringPort
    • value type: str (can be None)
  • zero_color
    Color of the zero line. The zero line is a dim line that shows where zero would be for a given channel. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Zero Color
    • default value: #7F7F7F
    • port type: StringPort
    • value type: str (can be None)
  • decoration_color
    Color of the axis decorations. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Decoration Color
    • default value: #000000
    • port type: StringPort
    • value type: str (can be None)
  • plot_markers
    Display markers if enabled.

    • verbose name: Plot Markers For Viewing
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • marker_color
    Color of vertical lines for marker events. Either a string or a dictionary that represents a mapping from event type to color (the special key '*' stands for all other markers).

    • verbose name: Marker Color
    • default value: #FF0000
    • port type: Port
    • value type: object (can be None)
  • line_width
    Line width for plotting.

    • verbose name: Line Width
    • default value: 0.75
    • port type: FloatPort
    • value type: float (can be None)
  • zeromean
    Display data with mean corrected to zero. This makes sure that each channel is centered for better viewing. If this is disabled, your data may be outside the window, especially if you have not performed high-pass filtering on your signal. Enabling this may make the curves appear to shift up or down if their mean is not already zero.

    • verbose name: Center (Zero-Mean) Channels For Viewing
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • autoscale
    Automatically scale channels to a standard scale. This makes sure that channels are rescaled such that they fit comfortably in the drawing area. All channels are rescaled by the same scale factor. Enabling this may make the curves appear to change scale suddenly, especially when large artifacts come into view or go out of view.

    • verbose name: Autoscale Data For Better Viewing
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • antialiased
    Draw graphics antialiased. If enabled, the lines will appear less pixelated or 'jaggy', however, this can slow down plotting.

    • verbose name: Draw Antialiased Lines
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • downsampled
    Draw downsampled graphics. This will reduce the sampling rate (i.e., time resolution) of the data if the display time range or sampling rate is so high that one sample would be shorter than a pixel on the screen. This can speed up plotting in such cases. WARNING: some versions of the underyling graphics library crash with this option enabled, so using this is not recommended unless absolutely necessary.

    • verbose name: Downsample Curves For Performance
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • nans_as_zero
    Show NaN values as zero.

    • verbose name: Nans As Zero
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and is formatted as [x, y, width, eight]. If x, y are set to 0 each, then the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 700, 500]
    • port type: ListPort
    • value type: list (can be None)
  • always_on_top
    Window should be always on top. If this is enabled, then the window will not be occluded by other windows.

    • verbose name: Always On Top
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • override_srate
    Optionally override sampling rate.

    • verbose name: Override Srate
    • default value: None
    • port type: FloatPort
    • value type: float (can be None)

SpectrumPlot

Plot a multi-channel spectrum in real time.

This node accepts streaming data that has a frequency axis (i.e., the spectrum has already been estimated using one of the spectral estimation nodes). This node does not handle data with multiple segments in it (it always plots the most recent segment), and it will plot the first matching stream if there are multiple streams. The node requires that the data has a frequency axis, and either a space (channels) or a feature axis. Any additional axes are folded into a flat space axis. For better viewing this node supports auto-scaling of the data to a standard scale (using the same scale factor for all channels), which is enabled by default. It also supports correction for the 1/f falloff curve observed in natural spectra. The node can either plot the spectra for all channels super-imposed, or it can stack the channels on top of each other. This node also provides keyboard shortcuts for changing the scale (+ and -), and for toggling the auto-scaling (a), stacking (s), and 1/f correction (f) options. Note that this plotter is not meant for offline ( e.g., scrollable) review of a whole dataset. Also note that this does not plot a 2d time/frequency image, but just the spectrum curve for the current time point.

Version 1.0.0

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • stream_name
    Name of stream to display. The first stream whose name starts with this string is displayed.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • scale
    Data scale. Increasing this value will magnify the plot curves correspondingly.

    • verbose name: Data Scaling
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)
  • stacked
    Display spectra stacked on top of each other instead of superimposed.

    • verbose name: Display Stacked Spectra
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • title
    Title of the plot. This is the title of the plot window. Placeholders like $(streamname) or $(sourceid) can be used here.

    • verbose name: Title Of Plot Window
    • default value: Spectrum view
    • port type: StringPort
    • value type: str (can be None)
  • background_color
    Background color. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Background Color
    • default value: #FFFFFF
    • port type: StringPort
    • value type: str (can be None)
  • line_color
    Color of the graph curves. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Line Color
    • default value: #000000
    • port type: StringPort
    • value type: str (can be None)
  • zero_color
    Color of the zero line. The zero line is a dim line that shows where zero would be for a given channel. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Zero Color
    • default value: #7F7F7F7F
    • port type: StringPort
    • value type: str (can be None)
  • decoration_color
    Color of the axis decorations. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Decoration Color
    • default value: #000000
    • port type: StringPort
    • value type: str (can be None)
  • line_width
    Line width for plotting.

    • verbose name: Line Width
    • default value: 0.75
    • port type: FloatPort
    • value type: float (can be None)
  • antialiased
    Draw graphics antialiased. If enabled, the lines will appear less pixelated or 'jaggy', however, this can slow down plotting.

    • verbose name: Draw Antialiased Lines
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • downsampled
    Draw downsampled graphics. This will reduce the sampling rate (i.e., time resolution) of the data if the display time range or sampling rate is so high that one sample would be shorter than a pixel on the screen. This can speed up plotting in such cases. WARNING: some versions of the underyling graphics library crash with this option enabled, so using this is not recommended unless absolutely necessary.

    • verbose name: Downsample Curves For Performance
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • autoscale
    Automatically scale channels to a standard scale. This makes sure that channels are rescaled such that they fit comfortably in the drawing area. All channels are rescaled by the same scale factor. Enabling this may make the curves appear to change scale suddenly, especially when large artifacts come into view or go out of view.

    • verbose name: Autoscale Data For Better Viewing
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and is formatted as [x, y, width, eight]. If x, y are set to 0 each, then the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 700, 500]
    • port type: ListPort
    • value type: list (can be None)
  • one_over_f_correction
    Correct for 1/f spectrum falloff. If enabled, the 1/f falloff curve frequently observed in natural signals will be compensated.

    • verbose name: Compensate For 1/f Falloff
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • always_on_top
    Window should be always on top. If this is enabled, then the window will not be occluded by other windows.

    • verbose name: Display Window Always On Top
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

TimeSeriesPlot

Plot a multi-channel continuous streaming time series in real time.

This node accepts streaming data, and maintains a view of the most recent n seconds of data (the window length is adjustible). The node is made for continuous (i.e., not segmented) data, and it will plot the first matching stream if there are multiple streams. The node requires that the data has a time axis, and either a space (channels) or a feature axis. All other axes (e.g., frequency) are folded into a flat space axis. For better viewing this node supports removing the mean of the data so that the signals are centered, as well as auto-scaling of the data to a standard scale (using the same scale factor for all channels), and these options are enabled by default. The node also provides keyboard shortcuts for changing the scale (+ and -), the displayed time range (* and /), and for toggling the auto-scaling (a) and zero-mean (z) options. Note that this plotter is not meant for offline (e.g., scrollable) review of a whole dataset.

Version 1.0.1

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • stream_name
    Name of stream to display. The first stream whose name starts with this string is displayed.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)
  • scale
    Data scale. Increasing this value will magnify the plot curves correspondingly.

    • verbose name: Data Scaling
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)
  • time_range
    Time range to display. This is the number of seconds of recent data that shall be plotted.

    • verbose name: Time Range To Display
    • default value: 5.0
    • port type: FloatPort
    • value type: float (can be None)
  • absolute_time
    Show absolute time in time axis. If this is enabled, then the absolute time stamps of the data will be displayed on the axis -- however, whether these start from zero or from some very large number depends on the data, and whether the stamps have been overwritten. Alternatively, and by default, this will plot the time relative to the most recent time point in the data (i.e., the current time point is 0.0, and 3 seconds earlier would be displayed as -3.0).

    • verbose name: Display Absolute Time Axis
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • title
    Title of the plot. This is the title of the plot window. Placeholders like $(streamname) or $(sourceid) can be used here.

    • verbose name: Title Of Plot Window
    • default value: Time series view
    • port type: StringPort
    • value type: str (can be None)
  • background_color
    Background color. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Background Color
    • default value: #FFFFFF
    • port type: StringPort
    • value type: str (can be None)
  • line_color
    Color of the graph curves. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Line Color
    • default value: #000000
    • port type: StringPort
    • value type: str (can be None)
  • auto_line_colors
    Automatically assign a different color to each line. Will take precedence over the line_color property.

    • verbose name: Auto Line Colors
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • zero_color
    Color of the zero line. The zero line is a dim line that shows where zero would be for a given channel. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Zero Color
    • default value: #7F7F7F
    • port type: StringPort
    • value type: str (can be None)
  • decoration_color
    Color of the axis decorations. This is in hexadecimal (web) notation (#RRGGBB). For instance 00 is zero, 7F is half brightness, and FF is full brightness, so #FF00FF yields a color that is a mix of bright red and blue, i.e., bright purple).

    • verbose name: Decoration Color
    • default value: #000000
    • port type: StringPort
    • value type: str (can be None)
  • marker_color
    Color of vertical lines for marker events. Either a string or a dictionary that represents a mapping from event type to color (the special key '*' stands for all other markers).

    • verbose name: Marker Color
    • default value: #FF0000
    • port type: Port
    • value type: object (can be None)
  • line_width
    Line width for plotting.

    • verbose name: Line Width
    • default value: 0.75
    • port type: FloatPort
    • value type: float (can be None)
  • plot_markers
    Display markers if enabled.

    • verbose name: Plot Markers For Viewing
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • plot_minmax
    Display min and max values of all incoming data if enabled. These values are calculated after scaling.

    • verbose name: Show Min/max Values Of Data For Viewing
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • zeromean
    Display data with mean corrected to zero. This makes sure that each channel is centered for better viewing. If this is disabled, your data may be outside the window, especially if you have not performed high-pass filtering on your signal. Enabling this may make the curves appear to shift up or down if their mean is not already zero.

    • verbose name: Center (Zero-Mean) Channels For Viewing
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • autoscale
    Automatically scale channels to a standard scale. This makes sure that channels are rescaled such that they fit comfortably in the drawing area. All channels are rescaled by the same scale factor. Enabling this may make the curves appear to change scale suddenly, especially when large artifacts come into view or go out of view.

    • verbose name: Autoscale Data For Better Viewing
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • antialiased
    Draw graphics antialiased. If enabled, the lines will appear less pixelated or 'jaggy', however, this can slow down plotting.

    • verbose name: Draw Antialiased Lines
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • downsampled
    Draw downsampled graphics. This will reduce the sampling rate (i.e., time resolution) of the data if the display time range or sampling rate is so high that one sample would be shorter than a pixel on the screen. This can speed up plotting in such cases. WARNING: some versions of the underyling graphics library crash with this option enabled, so using this is not recommended unless absolutely necessary.

    • verbose name: Downsample Curves For Performance
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • nans_as_zero
    Show NaN values as zero.

    • verbose name: Nans As Zero
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and is formatted as [x, y, width, height]. If x, y are set to 0 each, then the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 700, 500]
    • port type: ListPort
    • value type: list (can be None)
  • always_on_top
    Window should be always on top. If this is enabled, then the window will not be occluded by other windows.

    • verbose name: Always On Top
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • show_toolbar
    Whether to show the window toolbar.

    • verbose name: Show Toolbar
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • override_srate
    Optionally override sampling rate.

    • verbose name: Override Srate
    • default value: None
    • port type: FloatPort
    • value type: float (can be None)
  • no_concatenate
    Don't concatenate successive data. Can be used to display the content of a sliding window (e.g., MovingWindow node).

    • verbose name: No Concatenate
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

TopoPlotViewer

Plot EEG electrodes on head cartoon with different colors based on desired metric.

In discrete case define a set of boundary values and the color assigned to each section.

Version 1.0.0

Ports/Properties

  • set_breakpoint
    Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

    • verbose name: Set Breakpoint (Debug Only)
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • title
    Figure identifier. This identifier referenced in report templates.

    • verbose name: Title
    • default value: Electrode Metric Plot
    • port type: StringPort
    • value type: str (can be None)
  • head_option
    Flag to plot head cartoon.

    • verbose name: Plot Head
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • head_rad
    Drawing radius (arc_length) for the cartoon head. Note that only head_rad = 0.5 is anatomically correct.

    • verbose name: Head Rad
    • default value: 0.5
    • port type: FloatPort
    • value type: float (can be None)
  • plot_rad
    Maximum radius of channels to be plotted. If plot_rad > 0.5, channels with arc_length > 0.5 (i.e. below ears-eyes) are plotted in a circular 'skirt' outside the cartoon head.

    • verbose name: Plot Rad
    • default value: None
    • port type: FloatPort
    • value type: float (can be None)
  • head_color
    Head color.

    • verbose name: Head Color
    • default value: black
    • port type: StringPort
    • value type: str (can be None)
  • head_line_width
    Linewidth used for head, nose, ears

    • verbose name: Head Line Width
    • default value: 2
    • port type: IntPort
    • value type: int (can be None)
  • head_ring_width
    Width of the cartoon head ring.

    • verbose name: Head Ring Width
    • default value: 0.007
    • port type: FloatPort
    • value type: float (can be None)
  • head_axes_scfac
    Head to axes scaling factor.

    • verbose name: Head Axes Scfac
    • default value: 1.3
    • port type: FloatPort
    • value type: float (can be None)
  • value_discrete
    If set, the metric used for electrode values is considered to be discrete, and different levels and colors assigned to each level can be further defined.

    • verbose name: Value Discrete
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • value_range
    In case the values are discrete, the range includes the allowable levels of the metric. Otherwise, the two element list indicate the values assigned respectively to the minimum and maximum of the color limit.

    • verbose name: Value Range
    • default value: [0.95, 1.0]
    • port type: ListPort
    • value type: list (can be None)
  • color_range
    Color levels for discrete-valued plots.

    • verbose name: Color Range (Discrete-Valued)
    • default value: ['red', 'green']
    • port type: ListPort
    • value type: list (can be None)
  • color_range_cont
    Color map for continuous-valued plots.

    • verbose name: Color Range (Continuous-Valued)
    • default value: RdYlGn
    • port type: EnumPort
    • value type: object (can be None)
  • disk_scale
    The value used to scale the electrode disks.

    • verbose name: Disk Scale
    • default value: 150
    • port type: FloatPort
    • value type: float (can be None)
  • add_colorbar
    If set the color bar is added to the plot.

    • verbose name: Add Colorbar
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • color_bar_ticks_values
    List of the ticks values for the color bar.

    • verbose name: Color Bar Ticks Values
    • default value: None
    • port type: ListPort
    • value type: list (can be None)
  • color_bar_ticks_labels
    List of the ticks labels for the color bar.

    • verbose name: Color Bar Ticks Labels
    • default value: None
    • port type: ListPort
    • value type: list (can be None)
  • use_custom_colormap
    Can be used to activate custom color maps. Used for statistically thresholded plots.

    • verbose name: Use Custom Colormap
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • canvas_sizes
    Canvas size for the plot in inches. This is relevant when printing the figure.

    • verbose name: Canvas Sizes
    • default value: [7, 5.25]
    • port type: ListPort
    • value type: list (can be None)
  • canvas_dpi
    Canvas DPI. Determines print resolution.

    • verbose name: Canvas Dpi
    • default value: 100
    • port type: IntPort
    • value type: int (can be None)
  • always_on_top
    Window should be always on top. If this is enabled, then the window will not be occluded by other windows.

    • verbose name: Always On Top
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • show_toolbar
    Whether to show the window toolbar.

    • verbose name: Show Toolbar
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)
  • initial_dims
    Initial position of the window on the monitor. This is given in pixels, and is formatted as [x, y, width, eight]. If x, y are set to 0 each, then the window will appear in the top left corner of the screen.

    • verbose name: Initial Window Position
    • default value: [50, 50, 700, 500]
    • port type: ListPort
    • value type: list (can be None)