Skip to content

← utilities package

SetStreamProperties

Set (override or add) meta-data properties of a given stream.

In NeuroPype, each data packet has one or more streams (internally of type Chunk) carrying data such as EEG or event markers. Each such stream (chunk) has a dictionary of meta-data properties, holding information such as the modality of the data (EEG, NIRS, etc.), the origin of the data (file path that the data was originally loaded from), the name of the original LSL stream, the delay incurred by the applied filters, and so on. This node will override any specified properties in the stream which already exist (properties not specified are not deleted). Any specified properties which do not exist in the stream will be set (added). Multi-level properties can be specified using a period (.) as a delimiter: desc.cap.size will create a nested property that is <desc><cap><size>. You may specify a stream name to only override properties on that stream, or else all streams. To operate on select multiple streams (filtered by property, for example), use ExtractStreams before this node. Version 1.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

val1

Property value 1.

verbose name
Val1
default value
None
port type
DataPort
value type
object (can be None)
data direction
IN

val2

Property value 2.

verbose name
Val2
default value
None
port type
DataPort
value type
object (can be None)
data direction
IN

val3

Property value 3.

verbose name
Val3
default value
None
port type
DataPort
value type
object (can be None)
data direction
IN

val4

Property value 4.

verbose name
Val4
default value
None
port type
DataPort
value type
object (can be None)
data direction
IN

val5

Property value 5.

verbose name
Val5
default value
None
port type
DataPort
value type
object (can be None)
data direction
IN

valN

Additional property values.

verbose name
Valn
default value
None
port type
DataPort
value type
list (can be None)
data direction
IN

stream

Name of stream on which to set or override properties. Leave empty to override properties on all streams. Wildcards are supported (i.e., mystream* will match the first stream that begins with mystream.

verbose name
Stream To Override
default value
None
port type
StringPort
value type
str (can be None)

stream_name

verbose name
Stream Name
default value
None
port type
AliasPort
value type
str (can be None)

properties

Dictionary of properties to assign (where each key is the name of the property and the value is the value to assign to that property), i.e . {'modality': 'nirs'}. Use a dot (.) to indicate nested property names, i.e.: {'metadata.cap.size': '56'}. Note that, if a property of same name is provided both in this dictionary and passed via the property name/value ports,the latter take precedence and will override the value.

verbose name
Properties
default value
{}
port type
DictPort
value type
dict (can be None)

name1

Property name 1.

verbose name
Property Name 1
default value
None
port type
StringPort
value type
str (can be None)

name2

Property name 2.

verbose name
Property Name 2
default value
None
port type
StringPort
value type
str (can be None)

name3

Property name 3.

verbose name
Property Name 3
default value
None
port type
StringPort
value type
str (can be None)

name4

Property name 4.

verbose name
Property Name 4
default value
None
port type
StringPort
value type
str (can be None)

name5

Property name 5.

verbose name
Property Name 5
default value
None
port type
StringPort
value type
str (can be None)

nameN

Additional property names in list form.

verbose name
Additional Property Names
default value
None
port type
ListPort
value type
list (can be None)

only_signals

If set to True, non-signal streams (i.e ., marker streams) will be ignored.

verbose name
Only Signals
default value
False
port type
BoolPort
value type
bool (can be None)

allow_markers

If set to False, marker streams will be ignored.

verbose name
Allow Markers
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)