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 streaming data in a realtime bar chart.

This node expects the data to be a vector (with multiple values along the axis being plotted (i.e., the Feature axis). If the data has another axis with values (i.e., a Time axis), use the Mean node to reduce that axis down to a single value. This node can also plot non-streaming ("offline") data in which case a single image will be shown.

Version 1.2.2

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (can be None)

  • stream
    Name of stream to plot. Wildcards are supported, i.e. mystream* will plot the first stream whose name starts with mystream.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • value type: str (can be None)

  • max_channels
    Max number of bars to display. You can use the PgUp/PgDn (or u/d) keys to show the prev/next set of n bars.

    • verbose name: Max Bars To Plot
    • default value: 32
    • port type: IntPort
    • value type: int (can be None)

  • auto_line_colors
    Automatically assign a different color to each line or bar. Takes precedence if selected. See colormap property to determine the color selection.

    • verbose name: Auto Assign Colors
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • colormap
    Colormap to use for auto assign colors. (See matplotlib online documentation for colormap examples.)

    • verbose name: Colormap
    • default value: gist_rainbow
    • port type: EnumPort
    • value type: str (can be None)

  • background_color
    Background color. This can be hexadecimal (hex) notation (#RRGGBB) or CSS named colors ('white'). One resource (among many) that provides a list of both hex and CSS named colors is https://www.w3.org/wiki/CSS/Properties/color/keywords.

    • verbose name: Background Color
    • default value: #303030
    • port type: StringPort
    • value type: str (can be None)

  • decoration_color
    Color of the axis labels and ticks. (See background_color description for details.).

    • verbose name: Decoration Color
    • default value: #B0B0B0
    • port type: StringPort
    • value type: str (can be None)

  • plot_minmax
    Display min and max values of original data irrespective of scaling.

    • verbose name: Show Data Min/max Values
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

  • title
    Title of the plot window. The placeholders $(streamname), $(sourceid), and $(sourceurl) can be used here.

    • verbose name: Title
    • default value:
    • 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, height]. If x, y are set to 0 each, then the window will appear in the top left corner of the current screen.

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

  • left_offset
    Left offset of the window on the monitor. The x value in the initial window position property will be increased by this amount. Use this to shift all plots to a second monitor, for example. May be a negative number (i.e., to move plots to a window to the left).

    • verbose name: Left Offset
    • default value: 0
    • port type: IntPort
    • value type: int (can be None)

  • show_toolbar
    Show the window toolbar (which provides some additional functions).

    • verbose name: Show Toolbar
    • 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)

  • tight_layout
    Reduce the amount of white space around the plot within the window.

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

  • font_size
    Font size (in points) of text plotted outside the plot axes, such as axis labels, legend, etc.

    • verbose name: Font Size
    • default value: 11
    • port type: FloatPort
    • value type: float (can be None)

  • annotation_font_size
    Font size (in points) for text which appear inside the plot axes, such as markers, scale, etc.

    • verbose name: Annotation Font Size
    • default value: 11
    • port type: FloatPort
    • value type: float (can be None)

  • antialiased
    Draw graphics antialiased. If set to False, lines will appear more pixelated or 'jaggy', but plotting should render faster.

    • verbose name: Draw Antialiased Lines
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • line_color
    Color of the bars. (See background_color description for details.)

    • verbose name: Bar Color
    • default value: white
    • port type: StringPort
    • value type: str (can be None)

  • zero_color
    Color of the grid lines. (See background color description for details.)

    • verbose name: Zero Color
    • default value: #606060
    • port type: StringPort
    • value type: str (can be None)

  • line_width
    Width of the bars.

    • verbose name: Line Width
    • default value: 0.8
    • port type: FloatPort
    • value type: float (can be None)

  • label_rotation
    Orientation of plot Y axis tick labels.

    • verbose name: Label Rotation
    • default value: horizontal
    • port type: EnumPort
    • value type: str (can be None)

  • x_label
    Label for the X axis. Leave empty to automatically use a suitable default.

    • verbose name: X Label
    • default value:
    • port type: StringPort
    • value type: str (can be None)

  • y_label
    Label for the Y axis. Leave empty to automatically use a suitable default.

    • verbose name: Y Label
    • default value:
    • port type: StringPort
    • value type: str (can be None)

  • verbose
    Print additional information such as if the incoming packet has no data to plot, etc.

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

  • track_window_position
    Track the window position and print the new position in the console. This is useful for setting the window position property.

    • verbose name: Track Window Position
    • 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: IN

  • axis
    Axis from which to extract bar labels.

    • verbose name: Axis
    • default value: feature
    • port type: ComboPort
    • value type: str

  • 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)

  • y_limits
    Upper and lower limits of the bar plot. If this is set to [0, 0] and the data is offline (not streaming), the limits will be set to the min and max of the data.

    • verbose name: Y Axis Range
    • default value: [-50, 50]
    • port type: ListPort
    • value type: list (can be None)

  • 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)

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.7

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (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 of stream to display. Wildcards are supported.

    • verbose name: Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • 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: str (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)

  • 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)

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 for streaming data only.

Version 0.9.8

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (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 of stream to display. Wildcards are supported, i.e. mystream* will select the first stream whose name starts with mystream.

    • verbose name: Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • 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: str (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 in the plot.

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

  • 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)

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

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (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 of stream to display. Wildcards are supported, i.e. mystream* will select the first stream whose name starts with mystream. If unspecified, the first stream is displayed.

    • verbose name: Stream To Display
    • default value:
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • 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: str (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)

  • 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)

InspectPacket

Shows the contents of a Packet, including data tensor values, axes, streams, and markers.

Shows: 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; 4) a list of markers (if a marker stream is selected). If the packet contains multiple streams, a dropdown box is shown so that a particular stream can be selected. (The stream name to display can also be specified in the stream property; this may be recommended for datasets with many streams which may take a while to load.) 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. Note that in a pipeline with offline data, this node will keep the pipeline running until the window is closed using the 'close' button.

Version 3.1.2

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (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 data from the selected col/row axes, for selected stream.

    • verbose name: Show Data Table
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • show_axes_table
    Show list of the axes and their values, for selected stream.

    • verbose name: Show Axes Table
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • show_streams_table
    Show all streams in the packet and their properties.

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

  • show_markers_table
    Show the event markers, if any. This will be automatically enabled if a marker stream is selected.

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

  • stream
    Name of stream to display. If empty, the first non-empty stream 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. Wildcards are supported, i.e. mystream* will display the first stream whose name starts with mystream.

    • verbose name: Stream
    • default value: None
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • 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: ComboPort
    • value type: str (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: ComboPort
    • value type: str (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 esp if the file is large.

    • 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 avoids the plot becoming slow when handling offline data with very long axes (such as many timepoints). Set to 0 to show all values. This setting is ignored (set to 0) for streaming data since it's not an issue there.

    • 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: False
    • 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, 20, 800, 800]
    • port type: ListPort
    • value type: list (can be None)

  • verbose
    Show warnings (i.e ., selected axes not found in data, etc.).

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

  • ignore_signal_changes
    Ignore signal_changed events from other nodes, providing the plot has already initialized.

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

  • 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)

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 being sent as expected. .

Version 1.1.3

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (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 of stream to display. If unspecified, the first marker stream will be used. Wildcards are supported, i.e., mystream* will select the first stream whose name starts with mystream.

    • verbose name: Stream To Display
    • default value: markers
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • 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 with this value.

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

  • verbose
    Print messages to the log if no marker stream is found.

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

  • 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)

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. Centering and shifting time to start at 0 are enabled by default. To remove drift or a DC offset it is recommended to use a high-pass filter before using this node. Lines can be toggled on and off by clicking their label names in the y-axis. 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). The toolbar can be toggled on and off with 't', and the markers can be toggled on and off with 'm' (only if plot_markers is True).

Version 2.0.2

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (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 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)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • 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 (in seconds) to display.

    • verbose name: Time Range To Display
    • default value: 10.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)

  • figure_background_color
    Background color for figure window. This can be hexadecimal (web) notation (#RRGGBB) or CSS named colors ('white'). 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: Figure Background Color
    • default value: darkgray
    • port type: StringPort
    • value type: str (can be None)

  • plot_background_color
    Background color for inside subplot. This can be hexadecimal (web) notation (#RRGGBB) or CSS named colors ('white'). 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: Plot Background Color
    • default value: gainsboro
    • port type: StringPort
    • value type: str (can be None)

  • line_color
    Color of the graph curves. This is in hexadecimal (web) notation (#RRGGBB) or CSS named colors ('blue'). 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: mediumblue
    • 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)

  • colormap
    If using auto line colors, the color for each line will be spaced evenly using the desired colormap.

    • verbose name: Colormap
    • default value: brg
    • port type: EnumPort
    • 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) or CSS named colors ('white'). 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) or CSS named colors ('white'). 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: black
    • port type: StringPort
    • value type: str (can be None)

  • plot_markers
    Display markers if enabled. Note it is recommended to remove extraneous markers using SelectInstances node before plotting or the below "markers to show" parameter for faster loading and smoother scrolling. This can be toggled off by pressing 'm'.

    • verbose name: Plot Markers For Viewing
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • markers_to_show
    Display only event markers that are specified in a list of string names. If empty, all markers will be displayed. Limit the marker set for faster loading and smoother scrolling.

    • verbose name: Markers To Show
    • default value: []
    • port type: ListPort
    • value type: list (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: crimson
    • port type: Port
    • value type: object (can be None)

  • marker_text_alignment
    Alignment of event marker annotation text to either top or bottom of plot.

    • verbose name: Marker Text Alignment
    • default value: top
    • port type: EnumPort
    • 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)

  • font_size
    Font size (in points) of the x and y axis tick labels.

    • verbose name: Font Size
    • default value: 12.0
    • port type: FloatPort
    • value type: float (can be None)

  • titles_color
    Color of the title and x-axis label. This is in hexadecimal (web) notation (#RRGGBB) or CSS named colors ('black'). 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: Titles Color
    • default value: black
    • port type: StringPort
    • value type: str (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)

  • t0_is_zero
    Count time from zero. If set to False, the time starts at whatever is the first time stamp in the data.

    • verbose name: T0 Is Zero
    • 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 underlying 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: [100, 50, 1200, 900]
    • 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 to speed up plotting.

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

  • show_toolbar
    Whether to show the window toolbar. This can be toggled on or off by pressing 't'.

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

  • 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)

SpectrumPlot

Plot a multi-channel spectrum in real time.

This node assumes that spectrum has already been estimated using one of the spectral estimation nodes (i.e., Spectrogram). 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. This node is designed for continuous data (either streaming or offline), rather than segmented data. (If segmented, it always plots the most recent segment.) The node can either plot the spectra for all channels superimposed, or it can stack the channels on top of each other ("stacked mode"). Stacked mode is only available for streaming data. In stacked mode, the node automatically scales the data using a relative unit (std.dev). If not in stacked mode, you can choose whether to show the spectrum in absolute units (PSD or dB) or in relative units (std.dev). If in absolute units, the unit values are displayed along the Y axis, and the range can be set with the y_range property (which subsequently changes the scale). This node also supports correction for the 1/f falloff curve observed in natural spectra. This node provides keyboard shortcuts for toggling the stacking (s), and 1/f correction (1) options. This plotter can be used for "offline" (non-streaming) data, in which case the frequency plot is generated for the entire session or selected time segment. When plotting offline data, the Y axis can be either in absolute units (PSD or dB) or in relative units (std.dev). Stacked mode does not apply in offline mode.

Version 2.0.1

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (can be None)

  • stream
    Name of stream to plot. Wildcards are supported, i.e. mystream* will plot the first stream whose name starts with mystream.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • value type: str (can be None)

  • max_channels
    Max number of channels to display at once. Note that a large number of channels can slow the plot down considerably, and is not recommended. Alternatively, instead of increasing this, use the PgUp/PgDn (or u/d) keys in the plot window to show the prev/next set of n channels (where n is this number).

    • verbose name: Max Channels To Plot
    • default value: 32
    • port type: IntPort
    • value type: int (can be None)

  • auto_line_colors
    Automatically assign a different color to each line or bar. Takes precedence if selected. See colormap property to determine the color selection.

    • verbose name: Auto Assign Colors
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • colormap
    Colormap to use for auto assign colors. (See matplotlib online documentation for colormap examples.)

    • verbose name: Colormap
    • default value: gist_rainbow
    • port type: EnumPort
    • value type: str (can be None)

  • background_color
    Background color. This can be hexadecimal (hex) notation (#RRGGBB) or CSS named colors ('white'). One resource (among many) that provides a list of both hex and CSS named colors is https://www.w3.org/wiki/CSS/Properties/color/keywords.

    • verbose name: Background Color
    • default value: #303030
    • port type: StringPort
    • value type: str (can be None)

  • decoration_color
    Color of the axis labels and ticks. (See background_color description for details.).

    • verbose name: Decoration Color
    • default value: #B0B0B0
    • port type: StringPort
    • value type: str (can be None)

  • plot_minmax
    Display min and max values of original data irrespective of scaling.

    • verbose name: Show Data Min/max Values
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

  • title
    Title of the plot window. The placeholders $(streamname), $(sourceid), and $(sourceurl) can be used here.

    • verbose name: Title
    • default value:
    • 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, height]. If x, y are set to 0 each, then the window will appear in the top left corner of the current screen.

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

  • left_offset
    Left offset of the window on the monitor. The x value in the initial window position property will be increased by this amount. Use this to shift all plots to a second monitor, for example. May be a negative number (i.e., to move plots to a window to the left).

    • verbose name: Left Offset
    • default value: 0
    • port type: IntPort
    • value type: int (can be None)

  • show_toolbar
    Show the window toolbar (which provides some additional functions).

    • verbose name: Show Toolbar
    • 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)

  • tight_layout
    Reduce the amount of white space around the plot within the window.

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

  • font_size
    Font size (in points) of text plotted outside the plot axes, such as axis labels, legend, etc.

    • verbose name: Font Size
    • default value: 11
    • port type: FloatPort
    • value type: float (can be None)

  • annotation_font_size
    Font size (in points) for text which appear inside the plot axes, such as markers, scale, etc.

    • verbose name: Annotation Font Size
    • default value: 11
    • port type: FloatPort
    • value type: float (can be None)

  • antialiased
    Draw graphics antialiased. If set to False, lines will appear more pixelated or 'jaggy', but plotting should render faster.

    • verbose name: Draw Antialiased Lines
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • line_color
    Color of the lines. (See background_color description for details.)

    • verbose name: Line Color
    • default value: white
    • port type: StringPort
    • value type: str (can be None)

  • zero_color
    Color of the grid lines. (See background color description for details.)

    • verbose name: Zero Color
    • default value: #606060
    • port type: StringPort
    • value type: str (can be None)

  • line_width
    Width of the lines (or bars).

    • verbose name: Line Width
    • default value: 1.25
    • port type: FloatPort
    • value type: float (can be None)

  • label_rotation
    Orientation of plot Y axis tick labels.

    • verbose name: Label Rotation
    • default value: horizontal
    • port type: EnumPort
    • value type: str (can be None)

  • x_label
    Label for the X axis. Leave empty to automatically use a suitable default.

    • verbose name: X Label
    • default value:
    • port type: StringPort
    • value type: str (can be None)

  • y_label
    Label for the Y axis. Leave empty to automatically use a suitable default.

    • verbose name: Y Label
    • default value:
    • port type: StringPort
    • value type: str (can be None)

  • verbose
    Print additional information such as if the incoming packet has no data to plot, etc.

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

  • track_window_position
    Track the window position and print the new position in the console. This is useful for setting the window position property.

    • verbose name: Track Window Position
    • 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

  • stacked
    Display spectra stacked on top of each other instead of superimposed. If this is enabled, the Y axis will show the channel names and the unit be SD regardless of the unit setting.

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

  • unit
    The unit in which to display the data. By default, this node assumes the incoming data is PSD, and therefore selecting PSD does not further transform the data. Selecting dB will convert the data to dB before plotting, and selecting SD (Std Dev) will plot the standard deviation from the mean for each packet (if streaming data) or for the entire session (if offline data). Selecting data will plot the incoming data without any transformation, and use as the Y-axis label the Metadata.unit property of the chunk, if present.

    • verbose name: Unit
    • default value: PSD
    • port type: EnumPort
    • value type: str (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)

  • y_range
    Range of values to use for scaling of the Y axis, in the incoming unit (PSD, dB, StdDev). This only applies if stacked mode is off. If set to 0,0 the min and max values of the data is used as the range.

    • verbose name: Y Axis Range
    • default value: [0, 100]
    • port type: ListPort
    • value type: list (can be None)

  • scale
    Deprecated; data is always autoscaled in stacked mode, and otherwise, the y axis range property is used to determine the scale.

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

  • autoscale
    Deprecated; data is automatically autoscaled in stacked mode, and otherwise, the y axis range property is used to determine the scale.]

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

  • 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)

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 adjustable). This node can also be used to plot segmented data that has an instance axis (i.e., after the Segmentation node), in which case you can set the no_concatenate property to True to display each trial separately. This node requires that the data have a time axis, and either a space (channels) or the axis selected in the y_axis property. 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. For performance reasons the default max number of channels displayed is set at 32, which will displayed the first 32 channels in the data (if there are more than that). Use the PgDn and PgUp keys to show the next/prev set of 32 channels. You can also change the number of channels shown in the max_channels parameter. Note that this plotter is not meant for scrollable review of a non-streaming dataset; for that please use the ScrollingPlot node.

Version 1.2.3

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (can be None)

  • stream
    Name of stream to plot. Wildcards are supported, i.e. mystream* will plot the first stream whose name starts with mystream.

    • verbose name: Select Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • value type: str (can be None)

  • max_channels
    Max number of channels to display at once. Note that a large number of channels can slow the plot down considerably, and is not recommended. Alternatively, instead of increasing this, use the PgUp/PgDn (or u/d) keys in the plot window to show the prev/next set of n channels (where n is this number).

    • verbose name: Max Channels To Plot
    • default value: 32
    • port type: IntPort
    • value type: int (can be None)

  • auto_line_colors
    Automatically assign a different color to each line or bar. Takes precedence if selected. See colormap property to determine the color selection.

    • verbose name: Auto Assign Colors
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • colormap
    Colormap to use for auto assign colors. (See matplotlib online documentation for colormap examples.)

    • verbose name: Colormap
    • default value: gist_rainbow
    • port type: EnumPort
    • value type: str (can be None)

  • background_color
    Background color. This can be hexadecimal (hex) notation (#RRGGBB) or CSS named colors ('white'). One resource (among many) that provides a list of both hex and CSS named colors is https://www.w3.org/wiki/CSS/Properties/color/keywords.

    • verbose name: Background Color
    • default value: #303030
    • port type: StringPort
    • value type: str (can be None)

  • decoration_color
    Color of the axis labels and ticks. (See background_color description for details.).

    • verbose name: Decoration Color
    • default value: #B0B0B0
    • port type: StringPort
    • value type: str (can be None)

  • plot_minmax
    Display min and max values of original data irrespective of scaling.

    • verbose name: Show Data Min/max Values
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

  • title
    Title of the plot window. The placeholders $(streamname), $(sourceid), and $(sourceurl) can be used here.

    • verbose name: Title
    • default value:
    • 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, height]. If x, y are set to 0 each, then the window will appear in the top left corner of the current screen.

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

  • left_offset
    Left offset of the window on the monitor. The x value in the initial window position property will be increased by this amount. Use this to shift all plots to a second monitor, for example. May be a negative number (i.e., to move plots to a window to the left).

    • verbose name: Left Offset
    • default value: 0
    • port type: IntPort
    • value type: int (can be None)

  • show_toolbar
    Show the window toolbar (which provides some additional functions).

    • verbose name: Show Toolbar
    • 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)

  • tight_layout
    Reduce the amount of white space around the plot within the window.

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

  • font_size
    Font size (in points) of text plotted outside the plot axes, such as axis labels, legend, etc.

    • verbose name: Font Size
    • default value: 11
    • port type: FloatPort
    • value type: float (can be None)

  • annotation_font_size
    Font size (in points) for text which appear inside the plot axes, such as markers, scale, etc.

    • verbose name: Annotation Font Size
    • default value: 11
    • port type: FloatPort
    • value type: float (can be None)

  • antialiased
    Draw graphics antialiased. If set to False, lines will appear more pixelated or 'jaggy', but plotting should render faster.

    • verbose name: Draw Antialiased Lines
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • line_color
    Color of the lines. (See background_color description for details.)

    • verbose name: Line Color
    • default value: white
    • port type: StringPort
    • value type: str (can be None)

  • zero_color
    Color of the grid lines. (See background color description for details.)

    • verbose name: Zero Color
    • default value: #606060
    • port type: StringPort
    • value type: str (can be None)

  • line_width
    Width of the lines (or bars).

    • verbose name: Line Width
    • default value: 1.25
    • port type: FloatPort
    • value type: float (can be None)

  • label_rotation
    Orientation of plot Y axis tick labels.

    • verbose name: Label Rotation
    • default value: horizontal
    • port type: EnumPort
    • value type: str (can be None)

  • x_label
    Label for the X axis. Leave empty to automatically use a suitable default.

    • verbose name: X Label
    • default value:
    • port type: StringPort
    • value type: str (can be None)

  • y_label
    Label for the Y axis. Leave empty to automatically use a suitable default.

    • verbose name: Y Label
    • default value:
    • port type: StringPort
    • value type: str (can be None)

  • verbose
    Print additional information such as if the incoming packet has no data to plot, etc.

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

  • track_window_position
    Track the window position and print the new position in the console. This is useful for setting the window position property.

    • verbose name: Track Window Position
    • 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

  • x_axis
    Axis containing the data to plot along the X axis. Usually this is time, but may also be instance if plotting trials rather than a continuous time series.

    • verbose name: X Axis
    • default value: time
    • port type: ComboPort
    • value type: str

  • y_axis
    Axis containing the data to plot along the Y axis. Usually this is space, but can also be feature, frequency, or some other axis. If you have multiple axes of the same type, you can specify an axis by its custom label such as feature.concentrations.

    • verbose name: Y Axis
    • default value: space
    • port type: ComboPort
    • value type: str

  • time_range
    Time range to display. This is the number of seconds of data to 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. These will depend on the data, and you can use the ShiftTimestamps node prior to this node to reset them to 0 relative to the start of the data. If this property is false, the X axis will show 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). Note that this mode slows down the display.

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

  • plot_markers
    Display event markers as vertical lines.

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

  • marker_color
    Color of vertical lines for marker events. Either a string (see background_color description), 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: darkorange
    • port type: Port
    • value type: object (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
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

  • scale
    Data scale. Increasing this value will magnify the plot curves correspondingly. You can also use the + and - keys to change the scale interactively.

    • verbose name: Data Scale Factor
    • default value: 1.0
    • port type: FloatPort
    • value type: float (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
    • default value: True
    • 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)

  • no_concatenate
    Don't concatenate successive data. Can be used to display the content of a sliding window (e.g., after MovingWindow node), or trials (e.g., after Segmentation node).

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

  • override_srate
    Deprecated; use the OverrideSamplingRate before this node if necessary.

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

  • 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)

TimeSeriesSweepPlot

Plot a multi-channel continuous time series.

This node is more efficient at handling high sampling rate data than the TimeSeriesPlot and can be used to step backwards/forwards through offline (non-streaming) data. For additional details, see the TimeSeriesPlot node.

Version 1.0.1

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (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 of stream to display. The first stream whose name starts with this string is displayed.

    • verbose name: Stream To Display
    • default value: None
    • port type: StringPort
    • value type: str (can be None)

  • stream_name

    • verbose name: Stream Name
    • default value: None
    • port type: AliasPort
    • 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)

  • buffer_duration
    Duration of data to keep in the buffer. Only data in the buffer can be visualized.

    • verbose name: Duration Of Data That Can Be Visualized.
    • default value: 30.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.

    • 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: #7F7F7F7F
    • port type: StringPort
    • value type: str (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. Disabled with streaming data; use a high-pass filter node in front of this node instead. zeromean is not recommended for streaming data. Instead, put a high pass filter in front of this node.

    • 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: False
    • 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. This will likely crash with streaming data if the update rate is high.

    • verbose name: Downsample Curves For Performance
    • 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: []
    • 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)

  • 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)

  • 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)

TopoPlotViewer

Plot EEG channels (electrodes as discs) or NIRS channels (sources and detectors as discs, source-detector channels as lines) on a head, with colors based on the values in the incoming streaming data.

If the incoming values are discrete (i.e., using the Discritize node before this node), you can assign a fixed color to each value. If the values are continuous, you can select the colormap to assign colors to the values. This node expects the data to be a vector of channels, i.e., Space axis only with other axes (Time, Feature, Frequency, etc.) having been reduced prior to this node.

Version 1.2.0

Ports/Properties

  • metadata
    User-definable meta-data associated with the node. Usually reserved for technical purposes.

    • verbose name: Metadata
    • default value: {}
    • port type: DictPort
    • value type: dict (can be None)

  • data
    Data to display.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: IN

  • plot_values
    Array of pixel values.

    • verbose name: Plot Values
    • default value: None
    • port type: DataPort
    • value type: object (can be None)
    • data direction: OUT

  • 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_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)

  • background_color
    Background color

    • verbose name: Background Color
    • default value: white
    • port type: StringPort
    • value type: str (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: str (can be None)

  • disk_scale
    The value used to scale the channel disks.

    • verbose name: Disk Scale
    • default value: 250
    • port type: FloatPort
    • value type: float (can be None)

  • disk_opacity
    Opacity of the channel disks.

    • verbose name: Disk Opacity
    • default value: 0.5
    • port type: FloatPort
    • value type: float (can be None)

  • modality
    Modality of the data. If set to 'NIRS', the channels are plotted between the source and detector optodes. If 'EEG' or 'other', the channels are the electrodes themselves. If set to 'auto', the modality will be inferred from the data if specified, and 'other' is used if not.

    • verbose name: Modality
    • default value: auto
    • port type: EnumPort
    • value type: str (can be None)

  • show_labels
    Whether to show channel labels.

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

  • label_size
    Font size (points) for channel labels.

    • verbose name: Label Size
    • default value: 8
    • port type: IntPort
    • value type: int (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)

  • exit_on_close
    Whether to exit the program if the figure is closed.

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

  • debug_mode
    Instead of plotting, outputs the interpolated data. This can be used to validate the per-pixel output of the topoplot.

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

  • 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)