Skip to content

← signal_processing package

CombineChannels

Combine the given axis elements into new axis elements.

This node can be used to average multiple elements along an axis together into new axis elements (can also sum, take the max, etc.). For example, this can be used on a space axis to merge region-of-interest activations. Version 1.1.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

mapping

Grouping of old axis elements into new axis elements. The syntax is {'new_element1': [index0, index1, ...], 'new_element2': [index3, index4, index5, ...], ...} where 'new_elementX' is the new element name being defined, and the indexX terms are a list of terms to identify the old elements from which each new element would be formed, given as numeric indices (counting from 0), or the name of the old element (which may optionally contain asterisk wildcards). Example: {'mychan': [0,1,2], 'myotherchan': ['oldchanA','oldchanB','oldchanC']}.

verbose name
Element Grouping
default value
None
port type
Port
value type
object (can be None)

operation

Operation to perform on the old axis data to form the new axis element.

verbose name
Combine Operation
default value
average
port type
EnumPort
value type
str (can be None)

write_back

Define how new elements get written back into the axis. Replace-selected means that only the selected old axis elements will be replaced by the new elements and all non-selected elements will remain, replace-all means that only the new channels will be in the output, and append means that the new elements will be appended at the end.

verbose name
Write-Back Mode
default value
replace-selected
port type
EnumPort
value type
str (can be None)

ignore_nans

If activated the axis elements containing nan values are ignored.

verbose name
Ignore Elements With Nan Values
default value
False
port type
BoolPort
value type
bool (can be None)

support_wildcards

Support wildcard matches in mapping. If enabled, then the old axis element names in the mapping can be strings containing wildcards, such as 'FP*'.

verbose name
Support Wildcards In Grouping
default value
False
port type
BoolPort
value type
bool (can be None)

axis

The type of axis to operate on. Currently only named axis types (space and feature) are supported. The axis type may be appended by the axis label, separated by a ".", e.g., space.my_label .

verbose name
Axis
default value
space
port type
ComboPort
value type
str (can be None)

verbose

Print verbose diagnostic output.

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