Skip to content

← utilities package

SelectInstanceFields

Select (retain) or drop fields from an instance axis.

This can be used to drop extraneous variables from instance axes that may otherwise be included automatically by some nodes (i.e., plot nodes). Note that this will act on all instance axes found in all streams (except for marker streams if include_markers is False). Note that dropping (or adding) fields to the instance axis does not change the number of elements (items) along the instance axis, (rather these fields act as attributes of each element along the instance axis), and therefore does not change the shape of the data tensor in a stream. 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

retain_fields

Fields in the instance axis to select; all other fields will be dropped. An empty list will drop all fields. Note however that the 'Marker', 'TargetValue', and 'IsGood' fields cannot be dropped so in that case their values will be set to null instead.

verbose name
Fields To Select
default value
['Marker', 'TargetValue', 'IsGood']
port type
ListPort
value type
list (can be None)

inverse_selection

Inverse the selection. If True, the fields listed in retain_fields will be dropped and all others present in the instance axis will be retained.

verbose name
Inverse Selection
default value
False
port type
BoolPort
value type
bool (can be None)

include_markers

Also select (or drop) fields from marker streams. If false, only signal streams are processed.

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