Skip to content

← utilities package

RegulateChunkSizes

Fix up chunk size irregularities in streaming data using a buffer.

This node maintains a running estimate of the average number of samples that it receives on each update (e.g., 135 samples), and adjusts the amount of data that it outputs on each update to be this quantity of samples. The node maintains a buffer of configurable length to be able to absorb "hitches" in the input pipeline. As a result, the node outputs a very regular stream of samples even if the input processing chain has very irregular latency characteristics. One use of this node is to drive smooth-scrolling plots and other visualizations that shall be smoothly updating. Version 1.0.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

buffer_length

Buffer length. This is the length of the buffer to absorb hitches, in seconds.

  • verbose name: Buffer Length (Seconds)
  • default value: 1
  • port type: FloatPort
  • value type: float (can be None)

reset_on_gap

Reset the state if a gap is encountered that is longer than this. In seconds.

  • verbose name: Reset On Gap
  • default value: 5
  • port type: FloatPort
  • value type: float (can be None)

also_reset_buffer

Also reset buffer on gap.

  • verbose name: Also Reset Buffer
  • default value: False
  • 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)