EstimateUpdateRate¶
Estimate the update rate of NeuroPype.
Technically, the node simply estimates how many times per second NeuroPype updates this node. Typically this is the rate at which the entire pipeline updates, unless some special nodes were added to skip updating this node. 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
time_window¶
Estimation time window. In seconds.
- verbose name: Time Window
- default value: 5
- port type: IntPort
- value type: int (can be None)
ignore_empty_packets¶
Do not count empty packets. If this is enabled, the node essentially tracks the rate at which new non-empty data chunks are being received.
- verbose name: Ignore Empty Packets
- default value: False
- port type: BoolPort
- value type: bool (can be None)
measure_type¶
Whether to estimate the tick rate (in Hz) or the tick interval (in ms).
- verbose name: Measure Type
- default value: rate
- port type: EnumPort
- value type: str (can be None)
estimator¶
Estimator to use for the measure.
- verbose name: Estimator
- default value: mean
- port type: EnumPort
- value type: str (can be None)
display¶
Display result in console.
- verbose name: Display
- default value: True
- port type: BoolPort
- value type: bool (can be None)
display_interval¶
Display no more than every this many seconds.
- verbose name: Display Interval
- default value: 5
- port type: FloatPort
- value type: float (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)