Skip to content

← diagnostics package

LineNoise

A meta-node that performs a standard line noise chain to compute potential line noise contamination (for diagnostics).

The output values are a ratio of the amplitude of a band of frequencies close to the mains frequency to a band of frequencies on either side of that band. Lower values are better. Version 1.1.1

Ports/Properties

data

Data to process.

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

line_noise_frequency

Frequency in Hz that line noise is expected due to AC power (e.g . USA is 60 Hz, Europe is 50 Hz)

  • verbose name: Line Noise Frequency (Hz)
  • default value: 60Hz
  • port type: EnumPort
  • value type: str (can be None)

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: 2
  • 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)

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)