Skip to content

← visualization package

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

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)

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)