Skip to content

← utilities package

GetSamplingRate

Get the sampling rate of the given data.

This will retrieve the sampling rate from the first qualifying stream, which is the first stream that has a non-empty time axis, and optionally whose name starts with the given prefix. If no stream is found, or if the sampling rate is irregular, None is returned. 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
IN

srate

Sampling rate

verbose name
Srate
default value
None
port type
DataPort
value type
float (can be None)
data direction
OUT

stream

Name of stream from which to extract the channel names or prefix thereof. If blank will extract from the first qualifying stream.

verbose name
Stream
default value
port type
StringPort
value type
str (can be None)

verbose

Generate verbose output.

verbose name
Verbose
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)