Skip to content

← nirs package

CBSI

Apply the Correlation-Based Signal Improvement method to enhance the HbO/HbR contrast and downweight artifacts.

This node is applied after concentrations have been estimated, and after a wide bandpass filter that retains 0.01 Hz to 0.5 Hz. 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 0.5.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

Length of statistics window. This is the window length over which the standard deviation of the signal is tracked (online).

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

simulate_online

Simulate online processing even if data is available offline.

  • verbose name: Simulate Online
  • default value: False
  • 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)