Skip to content

← utilities package

OverrideTimestamps

Override the timestamps in the given data based on its nominal sampling rate, optionally pegged to the current "wall clock" reading.

If you peg the stamps to the clock, you will get jitters in the time stamps, because the times at which the clock is read out will not be exactly periodic -- however, you can easily dejitter the time stamps by inserting a Dejitter Timestamps node after this node. The main reason to use this node is when you have a data stream that has time stamps that are either garbage due to buggy data acquisition software, or which happen to be read off some other clock that is not synchronous with the current clock (e.g., playback of a previous recording, or data coming from another PC with no clock synchronization or drift compensation). In these cases you can achieve a moderate degree of synchronization using the wallclock (the timing will still be off by the amount of transmission latency, which can be on the order of 10s of miliseconds, but this is still better than nothing). Version 1.1.2

Ports/Properties

data

Data to process.

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

timebase

Time base to use. The wallclock setting uses the current computer clock, specifically the same clock as used by the Lab Streaming Layer, which allows you to achieve approximate synchronization to other LSL streams within a few 10s of miliseconds. Note that you may need to dejitter the time stamps using the Dejitter Timestamps node. UTC uses UTC time relative to the current computer clock (equivalent to wallclock + the UTC offset of the current computer clock). The abstract clock has no jitter, but is not synchronized to anything. Keep retains the current timestamps.

  • verbose name: Time Base
  • default value: wallclock
  • port type: EnumPort
  • value type: str (can be None)

include_markerstreams

Handling of marker stream: if set to 'brute', markers are simply re-timestamped upon arrival. This will be somewhat inaccurate, especially if the tick rate is low and or a tick covers a lot of time (e.g., during playback).

  • verbose name: Include Markerstreams
  • default value: skip
  • port type: EnumPort
  • 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)