Skip to content

← utilities package

PropagateNaNs

Propagate NaNs within a data packet following a specified rule.

This can be used, for example, to propagate bad-sample masks between different NIRS wavelengths, or to carry over a NaN mask from one stream to another. Version 1.0.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

other

Secondary stream.

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

rule

Propagation rule. The same_position mode will propagate to channels that have the same position, e.g., wavelengths in NIRS, including dark measurements if present. The from_other mode will propagate NaNs from the other packet to the data packet.

  • verbose name: Rule
  • default value: from_other
  • 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)