Skip to content

← signal_processing package

ArtifactRegression

Remove artifacts by regression from data using specified reference channels.

This is an online filter that operates on continuous data, and removes artifacts using a regression technique, if artifact channels (e.g., EOG or EMG) are present (using recursive least squares). Note that noise in the artifact signals may be transferred onto the other channels. This filter is meant to be run on continuous data. Therefore, it should not be preceded by a Segmentation node. This node maintains internal state. 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

forget_halftime

Half-life time constant of filter, in seconds. Data that lies this many seconds in the past will be weighted half as much as the most recent data when designing the filter, and data twice as old will be weighted by 1/4, etc. Can also be thought of as the half-life of the weights for an exponentially weighted filter. (default = 60 seconds).

  • verbose name: Adaptive Filter Half-Life Constant
  • default value: 60
  • port type: FloatPort
  • value type: float

kernel_length

Kernel Length. The length/order of the temporal FIR filter kernel.

  • verbose name: Kernel Length
  • default value: 3
  • port type: IntPort
  • value type: int (can be None)

reference_axis

Axis along which to take the reference channels. In most cases this is the space axis.

  • verbose name: Select Reference Along Axis
  • default value: space
  • port type: ComboPort
  • value type: str (can be None)

reference_channels

List of artifact reference channel indices or channel names to use as reference for regression. When the space axis is used, this is typically a channel range (e.g. '0:1', [0, 1]) or list of channel names (e.g. ['Fp1', 'Fp2']).

  • verbose name: Reference Selection
  • default value: :
  • port type: Port
  • value type: object (can be None)

reference_unit

Unit in which the reference selection is given. If the axis is other than space or feature, the unit must be set to indices.

  • verbose name: Unit For Reference Selection
  • default value: indices
  • port type: EnumPort
  • value type: str (can be None)

use_caching

Enable caching.

  • verbose name: Use Caching
  • default value: True
  • 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)