Skip to content

← signal_processing package

ChannelBaselineCalibration

This node can be used to "zero" an output signal based on some initial baseline calibration data.

A typical use case is when you have a pipeline that computes an output signal that may be positive or negative, e.g., imagined movement or emotional state, and that output is biased in an undesirable way (e.g., emotional state pegged to "excited"). In such cases you can place this node at the end, an just prior to using the pipeline you gather a baseline period where you know that the desired output should be zero (e.g., neutral emotional state). This node will then compute the average on each channel of the output in that period, store it, and from then on subtract that value from the signal, so that a neutral state yields the desired unbiased zero output. The assumption is that then the entire output range will be shifted roughly as desired (e.g., negative emotional state would be below zero, etc.). The node can also be used on non-streaming data, in which case the baseline will be calculated from the entire data. Version 1.0.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

calib_length

Data length for calibration. In seconds when applied to a time-domain signal, otherwise this is the number of instances/segments/trials to calibrate on.

  • verbose name: Calibration Duration
  • default value: 15
  • port type: IntPort
  • value type: int (can be None)

offline_all

Whether to use all data in the offline case. If set to False, will also respect the calib_length.

  • verbose name: Use All Data If Non-Streaming
  • default value: True
  • port type: BoolPort
  • value type: bool (can be None)

estimator

Type of estimator to use. The median estimator is robust.

  • verbose name: Estimator
  • default value: mean
  • 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)