Skip to content

← visualization package

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

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)

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)