Skip to content

← diagnostics package

HighFrequencyNoise

A meta-node that obtains a ratio of high frequencies (e.g

. >50 Hz) to all frequencies. Used to diagnose potentially bad channels. (Lower values are better.). You should use a highpass filter at 0.5 or 1 Hz before this node (i.e., FIRFilter). Version 1.1.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

window_length

Sliding window length. A longer window will yield a better estimate, but the spectrum will change more slowly and will also react more slowly to changes. Typical settings for EEG phenomena are 0.5 to 5 seconds, but for very slowly (or rapidly) changing brain dynamics, longer (or shorter) windows may be used.

verbose name
Sliding Window Length
default value
10
port type
FloatPort
value type
float (can be None)

unit

Unit in which the window length is given.

verbose name
Unit Of Measurement For Window Length
default value
seconds
port type
EnumPort
value type
str (can be None)

frequencies

Transition frequencies for the highpass filter. Provide two frequencies to determine the rolloff curve.

verbose name
Frequencies
default value
[45, 50]
port type
ListPort
value type
list (can be None)

exclude_line_noise

Do not take line noise into account. If true, the line noise frequencies are filtered out before calculating the high frequency noise metric.

verbose name
Exclude Line Noise
default value
True
port type
BoolPort
value type
bool (can be None)

stop_atten

Stopband attenuation in dB for the internal highpass and notch filters. Higher values (e.g. 120) give sharper rolloff and more accurate estimates, but increase computation time. Lower values (e.g. 80) are faster, especially on ARM systems.

verbose name
Stop Atten
default value
120
port type
IntPort
value type
int (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)