Skip to content

← formatting package

SeparateStreamProperties

Selectively split properties of streams off into a separate dictionary.

This node identify stream properties that match the remove or drop lists, remove them from the packet, and return them in a separate dictionary (over the props output). Both remove and retain lists can contain predefined collections of properties, such as (Flags), (Origin), and (Metadata) as shorthands for the full listings, which can be further refined as desired by combining the retain and drop lists. Version 0.5.0

Ports/Properties

data

Data to process.

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

props

Separated properties.

  • verbose name: Props
  • default value: None
  • port type: DataPort
  • value type: dict (can be None)
  • data direction: OUT

retain

List of properties to retain. The properties in braces represent all properties in a specific predefined collection, where (Flags) is the Flags collection (e.g., is_signal), (Origin) is the list of origin properties (e.g., source_url), and (Metadata) is the list of predefined metadata (e.g., unit). See also NeuroPype constants for the content of these listings.

  • verbose name: Retain
  • default value: ['(Flags)', '(Origin)', '(Metadata)']
  • port type: ListPort
  • value type: list (can be None)

remove

List of properties to remove. Note that, if retain is given, then this will further prune the properties from those listed in retain. See also retain for the predefined collections that can be named here.

  • verbose name: Remove
  • default value: []
  • port type: ListPort
  • value type: list (can be None)

stream_name

If given, apply to streams whose name starts with this prefix.

  • verbose name: For Streams Starting With
  • default value: None
  • port type: StringPort
  • value type: str (can be None)

verbose

If True, print verbose output.

  • verbose name: Verbose
  • 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)