Skip to content

← formatting package

FuseStreams

Fuse all streams in streaming data into a single multi-channel stream.

The time stamps of the input stream must all be on the same type of clock, for instance all coming from LSL or all stamped using UTC time. This node assumes that the samples in the inserted streams are regularly sampled. While the sampling rates need not be the same, best results will be obtained when fusing a slow-changing signal into a higher rate one. This node expects all streams have space and time axes only; all other axes must have a length of zero. This node is designed for streaming data only. (This node is in beta and may not work as expected under all conditions.) Version 0.9.7

Ports/Properties

data

Data to process.

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

srate

Output sampling rate. This is the nominal sampling rate of the output stream. Note that if this is lower than the sampling rate of any of the input streams, these streams must have been low-pass filtered with a cutoff frequency of half the new sampling rate (otherwise spectral aliasing will occur).

  • verbose name: Output Sampling Rate
  • default value: 125
  • port type: IntPort
  • value type: int (can be None)

verbosity

Verbosity level. 0=off, 1=essential verbosity, 2=full verbosity, 3=unreasonable verbosity.

  • verbose name: Verbosity
  • default value: 1
  • port type: IntPort
  • value type: int (can be None)

min_headroom

Minimum buffer headroom. This is the minimum amount of space ahead of the most recent message that shall be reserved in the buffer. If there is less remaining headroom than that, we grow the buffer up to the desired amount of headroom.

  • verbose name: Minimum Buffer Headroom
  • default value: 2
  • port type: FloatPort
  • value type: float (can be None)

desired_headroom

Desired buffer headroom. When we grow the buffer to accommodate more recent message insertions, we grow it such that we gain this much headroom. This value must be somewhat larger than the minimum headroom so that we don't have to grow the buffer with every message in the worst case.

  • verbose name: Desired Buffer Headroom
  • default value: 5
  • port type: FloatPort
  • value type: float (can be None)

buffer_delay

Tolerable buffer delay. This is the delay versus the median most recent sample time (taken across clients), that we allow due to buffering of data. If this is set too low, then not all clients will have had a chance to have their data transmitted by the time the buffered data is due for flushing, and the respective channels will contain NaNs to indicate missing data. The larger this value is, the larger the percentage of clients whose data will have made it into the buffer by the time it is released (a good value is the maximum reasonable delay that a client may experience vs. the typical client).

  • verbose name: Tolerable Buffer Delay
  • default value: 2
  • port type: FloatPort
  • value type: float (can be None)

stream_name

Name of the fused stream.

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