Skip to content

← visualization package

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

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

font_size

Font size of the event marker text.

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

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)