Skip to content

← diagnostics package

EstimateLag

Estimate the lag (delay) of the data in seconds, as computed by the difference between the timestamp of the incoming data and the LSL or wallclock time it was received.

This node is for use with online data only. The lag values are also output through a separate port with a Time x Feature axis. This node operates on signal streams only. Version 0.8.0

Ports/Properties

data

Data to process.

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

lag

Lag values.

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

timebase

Time base to use. The neuropype/lsl setting uses the standard NP/LSL clock. If you have a data source that uses the wall clock as time stamps, then use wallclock.

verbose name
Time Base
default value
neuropype/lsl
port type
EnumPort
value type
str (can be None)

verbose

Display lag in console with every tick.

verbose name
Verbose
default value
False
port type
BoolPort
value type
bool (can be None)

threshold

Lag threshold, in seconds. If the lag exceeds this threshold, an error message is printed to the log (and console). Set to 0 to ignore any threshold; this will log the log in the console if verbose is True but otherwise set no .

verbose name
Threshold
default value
0.5
port type
FloatPort
value type
float (can be None)

Pop up a notification window when the threshold if exceeded. When set to false, an error is printed to the log stream only.

verbose name
Popup Window
default value
False
port type
BoolPort
value type
bool (can be None)

Optional label. This allows you to place the node at multiple points in the pipeline while being able to tell the result apart in the console printout (if verbose set to True).

verbose name
Print Label
default value
default
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)