Skip to content

← neural package

ArtifactDetection

Detect artifacts in a sliding window fashion and mark them up with NaNs.

Version 1.1.2

Ports/Properties

data

Data to process.

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

std_threshold

Detection threshold in standard deviations. Relative to the baseline window. If the signal amplitude in the detection window is greater than the amplitude in the baseline window by at least this factor, the data is considered artifactual.

  • verbose name: Std Threshold
  • default value: 5
  • port type: FloatPort
  • value type: float (can be None)

baseline_window

Baseline window length. In seconds. This window is used to robustly track the expected signal standard deviation.

  • verbose name: Baseline Window
  • default value: 60
  • port type: FloatPort
  • value type: float (can be None)

detection_window

Detection window length. This window is used to detect short-duration artifacts.

  • verbose name: Detection Window
  • default value: 0.15
  • port type: FloatPort
  • value type: float (can be None)

drift_window

Window length for robustly tracking the signal drift.

  • verbose name: Drift Window
  • default value: 10
  • port type: FloatPort
  • value type: float (can be None)

lookahead

Lookahead duration. The node will delay the output signal by this many seconds. Allows to catch sharp-onset artifacts before they are being passed to the downstream pipelines.

  • verbose name: Lookahead
  • default value: 0.075
  • 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)