TopoPlotViewer¶
Plot EEG channels (electrodes) or NIRS channels (sources and detectors as discs, source-detector channels as lines) on a head outline, with colors based on the values in the incoming data.
Optionally interpolate the values between channels (with or without contour lines). If the incoming values are discrete (i.e., using the Discretize 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 any other axes (Time, Feature, Frequency, etc.) having been reduced prior to this node (i.e., use Mean followed by StripSingletonAxis). This node will work with streaming or non-streaming ("offline") data, however the interpolation feature may be too slow for real-time use. Version 1.4.1
Ports/Properties¶
data¶
Data to display.
figure_out¶
Plot data for PlotDashboard (TopoPlotData when suppress_window is enabled).
plot_values¶
Array of pixel values.
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.
interpolation¶
Whether to interpolate the electrode values across the topoplot. "none" performs no interpolation, "map" performs an interpolation and "contour" adds contour lines to the interpolation. This setting is ignored if modality is "NIRS" (since that plots lines rather than electrodes).
plot_disks¶
Plot the electrodes (channels) as disks.
disk_scale¶
Data scaling factor that determines the size of the electrode (channel) disks.
head_option¶
Plot the head outline.
head_line_width¶
Line width used for head, nose, ears outline.
head_ring_width¶
Width of the blank ring around the head (nose, ears and outer electrodes are plotted outside this ring.
head_axes_scfac¶
Head to axes scaling factor.
head_rad¶
Drawing radius (arc_length) for the head outline. Note that only a value of 0.5 reflects the conventional projection, so normally you should not change this value.
plot_rad¶
Maximum radius of channels to be plotted. If this value is greater than the head radius , channels which falls outside the head radius (i.e. below ears/eyes) will plotted in a circular 'skirt' outside the head outline; if it is equal to or smaller than the head radius, those channels falling outside the head radius will not be plotted. If None, this will be set to a value that includes the channels furthest from the head center, multiplied by the head_padding_scale.
padding_scale¶
If the plot radius is not specified, this value is used to scale the interpolation radius based on the outermost channels in the data, "padding" the distance between the head outline and the plot limits.
num_contours¶
Number of contour lines to draw. This setting is only relevant if interpolation is set to "contour".
contour_line_width¶
Width of the contour lines. This setting is only relevant if interpolation is set to "contour".
color_range_cont¶
Color map for continuous-valued plots.
color_range¶
Color levels for discrete-valued plots.
background_color¶
Background color
head_color¶
Head outline color.
disk_opacity¶
Opacity of the fill color in the electrode (channel) disks. This will also be used for the color bar if the disks are plotted.
contour_line_color¶
Color of the contour lines. This setting is only relevant if interpolation is set to "contour".
use_custom_colormap¶
Use for statistically thresholded plots. Before using this colormap, you should have masked the data using a p-value threshold. That is, values greater than that p-value threshold are forced to zero, while the original values are retained for the rest.
value_discrete¶
If True, the metric used for electrode values is considered to be discrete, and different levels and colors assigned to each level can be further defined in the value range and color range (discrete-valued) properties.
value_range¶
If value_discrete is True, the range includes the allowable levels of the metric. Otherwise, the two element list indicate the values which define the minimum and maximum of the color limits as shown in the color bar. If unspecified, the minimum and maximum values in the data are used.
title¶
Figure title.
title_font_size¶
Font size (in points) for the figure title.
show_labels¶
Show electrode (channel) labels.
label_size¶
Font size (points) for channel labels.
add_colorbar¶
Show a color bar.
color_bar_ticks_values¶
List of the ticks values for the color bar.
color_bar_ticks_labels¶
List of the ticks labels for the color bar.
always_on_top¶
Window should be always on top. If this is enabled, then the window will not be occluded by other windows.
show_toolbar¶
Whether to show the window toolbar.
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.
canvas_sizes¶
Canvas size for the plot in inches. This is relevant when printing the figure.
canvas_dpi¶
Canvas DPI. Determines print resolution.
exit_on_close¶
Whether to exit the program if the figure is closed.
suppress_window¶
Suppress the plot window. When enabled, the figure is rendered off-screen and only output on the figure port, without opening a visible window. Use this when feeding the figure into a Figure Dashboard node.
max_redraw_hz¶
Maximum redraw rate of this table in Hz. Limits how often the matplotlib canvas is repainted (and how often a Plot Dashboard re-renders this table panel). 0 means no throttle. Lowering this can significantly reduce visualization overhead where matplotlib.table draws are expensive (i.e., MacOS).
debug_mode¶
Instead of plotting, outputs the interpolated data. This can be used to validate the per-pixel output of the topoplot.
set_breakpoint¶
Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.
metadata¶
User-definable meta-data associated with the node. Usually reserved for technical purposes.