Module: elementwise_math

Elementwise math operations.

These nodes operate on data packets on an element-by-element basis. Most elementwise math operations are found here.

Add

Add the data across the given data inputs (elementwise).

Note that the shape of the arrays must be the same for all data inputs.

Version 1.1.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data3
    Input data 3.

    • verbose name: Data3
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data4
    Input data 4.

    • verbose name: Data4
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data5
    Input data 5.

    • verbose name: Data5
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data6
    Input data 6.

    • verbose name: Data6
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data7
    Input data 7.

    • verbose name: Data7
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data8
    Input data 8.

    • verbose name: Data8
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data9
    Input data 9.

    • verbose name: Data9
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data10
    Input data 10.

    • verbose name: Data10
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • dataN
    Additional input data.

    • verbose name: Datan
    • default value: None
    • port type: DataPort
    • value type: list (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Earlier binary forms of these operations used to return the first argument when the second argument was None, but did not do the same in the reverse case. Since n-ary operations are commutative, the new behavior is to return whichever argument was not None in such a case, or more generally to ignore None inputs and operate on the remaining ones. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

ArcCos

Calculate the inverse cosine of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ArcCosh

Calculate the inverse hyperbolic cosine of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ArcSin

Calculate the inverse sine of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ArcSinh

Calculate the inverse hyperbolic sine of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ArcTan

Calculate the inverse tangent of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ArcTan2

Take the elementwise arc tangent (atan2) of the two given inputs.

This can be interpreted as the angle of a vector whose x and a y coordinates are given by the second and first input, respectively.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

ArcTanh

Calculate the inverse hyperbolic tangent of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ArrayAnd

Computes the elementwise AND operation between two or more objects.

The result is of the highest type of the inputs (packet, array, list, or scalar), and for each element, the result is set to True if all of the inputs are True, and False otherwise.

Version 1.0.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data3
    Input data 3.

    • verbose name: Data3
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data4
    Input data 4.

    • verbose name: Data4
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data5
    Input data 5.

    • verbose name: Data5
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data6
    Input data 6.

    • verbose name: Data6
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data7
    Input data 7.

    • verbose name: Data7
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data8
    Input data 8.

    • verbose name: Data8
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data9
    Input data 9.

    • verbose name: Data9
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data10
    Input data 10.

    • verbose name: Data10
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • dataN
    Additional input data.

    • verbose name: Datan
    • default value: None
    • port type: DataPort
    • value type: list (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Earlier binary forms of these operations used to return the first argument when the second argument was None, but did not do the same in the reverse case. Since n-ary operations are commutative, the new behavior is to return whichever argument was not None in such a case, or more generally to ignore None inputs and operate on the remaining ones. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

ArrayNot

For each element in the data, take the logical negation (NOT) of the element.

For numeric data, any element that is non-zero will be converted to False, and any element that is zero will be converted to True.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ArrayOr

Computes the elementwise OR operation between two or more objects.

The result is of the highest type of the inputs (packet, array, list, or scalar), and for each element, the result is set to True if any of the inputs are True, and False otherwise.

Version 1.0.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data3
    Input data 3.

    • verbose name: Data3
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data4
    Input data 4.

    • verbose name: Data4
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data5
    Input data 5.

    • verbose name: Data5
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data6
    Input data 6.

    • verbose name: Data6
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data7
    Input data 7.

    • verbose name: Data7
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data8
    Input data 8.

    • verbose name: Data8
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data9
    Input data 9.

    • verbose name: Data9
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data10
    Input data 10.

    • verbose name: Data10
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • dataN
    Additional input data.

    • verbose name: Datan
    • default value: None
    • port type: DataPort
    • value type: list (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Earlier binary forms of these operations used to return the first argument when the second argument was None, but did not do the same in the reverse case. Since n-ary operations are commutative, the new behavior is to return whichever argument was not None in such a case, or more generally to ignore None inputs and operate on the remaining ones. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

ArrayXor

Computes the elementwise XOR operation between two objects.

The result is of the highest type of the inputs (packet, array, list, or scalar), and for each element, the result is set to True if it is true for exactly one of the inputs, and False otherwise.

Version 1.0.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

Clamp

Clamp each element in the data between a minimum and a maximum.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • min
    Minimum value. Any values in the data that are smaller than this will be replaced by this value.

    • verbose name: Min
    • default value: -1.0
    • port type: FloatPort
    • value type: float (can be None)
  • max
    Maximum value. Any values in the data that are larger than this will be replaced by this value.

    • verbose name: Max
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)

ConditionalReplaceValues

Replace values that meet a given criteria.

Compare each value in the data against a given value using a given operator, and replace those which meet the criteria with a new value. For example, if new_value is 0, the comparator_value is 3 and the comparator_operator is < then any values below 3 will be replaced with 0.

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • comparator_value
    Value against which each value in the data is compared.

    • verbose name: Comparator Value
    • default value: 0
    • port type: FloatPort
    • value type: float (can be None)
  • comparator_operator
    Operator used in the comparison. Values for which the comparison is true will be replaced with the new value.

    • verbose name: Comparator Operator
    • default value: =
    • port type: EnumPort
    • value type: str (can be None)
  • new_value
    Replacement value for all values which meet the criteria

    • verbose name: New Value
    • default value: 0
    • port type: FloatPort
    • value type: float (can be None)

Cos

Calculate the cosine of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Cosh

Calculate the hyperbolic cosine of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Discretize

Discretize the input data (continuous) through a multi-level threshold function.

Input values that are below a threshold are mapped to a constant value (usually 0.0), and values that are above the threshold are mapped to another constant value (usually 1.0). This can be extended to an unlimited number of threshold levels. The new mapped values just need to contain 1 more value than the given number of threshold levels.

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • threshold_cutoffs
    List of threshold values in sequential order. Can be any length.

    • verbose name: Threshold Cutoff Values
    • default value: [0.5]
    • port type: ListPort
    • value type: list (can be None)
  • newvals
    List of mapped values. Values that are smaller than a given threshold will be mapped to the first constant, and values that are larger than or equal to the next threshold will be mapped to the next constant. This list needs to be exactly 1 value longer than the list of threshold cutoff values. Example: threshold cutoff values = [5, 10]; new values = [0, 1, 2]. All data below 5 will now be 0, data between 5 and 10 will now be 1, data greater than 10 will now be 2 .

    • verbose name: New Values
    • default value: [0, 1]
    • port type: ListPort
    • value type: list (can be None)

Divide

Divide the data in the first input by the data in the second input (elementwise).

Note that the shape of the arrays must be the same for both data inputs.

Version 1.1.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

ElementwiseExpression

Apply a math expression to each element in the data.

The given expression is a string in Python syntax (similar to the syntax in a graphing calculator), where the variable x to refers to the incoming data. The result of this expression is the output data. The regular mathematical functions are available -- for example, "sqrt(x)*2 + x" is allowed. This node is not available in cloud pipelines. Since this operation applies element-wise, the shape of the data array is unchanged. An advanced feature for power users is the support of special one-letter symbols that stand for special vectors that index the axes of the data array. For instance, t is the vector of time points if a time axis is present, f is the vector of frequency values of the frequency axis, i, j, and k are zero-based indices for the instance, feature, and generic axis, respectively, and u, v, w are the three coordinates of the space axis. Note that these variables are only usable when the data has the respective axes. Also, since these are row vectors while the data is an n-dimensional array, it may be necessary to use numpy reshape/transpose operations to yield the desired result (all numpy functions are available, without the need to use the "np." prefix).

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • expression
    Expression to apply. The data is referred to as x. Example: sqrt(x)*2 + x. WARNING: This node is unsafe for use with untrusted strings, i.e., as received from the web.

    • verbose name: Expression
    • default value: x
    • port type: StringPort
    • value type: str (can be None)

EqualTo

For each array element in data1, test whether it is equal to the corresponding element in data2.

This operation returns an array, but you can also wire out the all_true or any_true outputs, which yield a single boolean (true/false) value that indicates whether the test came out true for all elements (or for any element). These outputs can then be wired into nodes that accept booleans, like the IfElse node. Alternatively you can use the All or Any nodes to convert arrays of booleans into a single boolean. Tip: if you wish to compare arrays in shape and content (i.e., arrays of different shape will be considered not-equal), you can use the AllEqual node instead.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumericOrStr (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: Port
    • value type: object (can be None)
  • all_true
    True if all data values are True.

    • verbose name: All True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT
  • any_true
    True if any data values are True.

    • verbose name: Any True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT

Exponent

Exponentiate a constant base given each element in the data.

For each element of the data, the base is raised to a power given by that element.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • base
    Base of the exponent. This base will be raised to a power given by each element of the data. If None is given, Euler's number will be assumed.

    • verbose name: Base
    • default value: 2.718281828459045
    • port type: FloatPort
    • value type: float (can be None)

GreaterOrEqual

For each array element in data1, test whether it is greater than or equal to the corresponding element in data2.

This operation returns an array, but you can also wire out the all_true or any_true outputs, which yield a single boolean (true/false) value that indicates whether the test came out true for all elements (or for any element). These outputs can then be wired into nodes that accept booleans, like the IfElse node. Alternatively you can use the All or Any nodes to convert arrays of booleans into a single boolean.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumericOrStr (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: Port
    • value type: object (can be None)
  • all_true
    True if all data values are True.

    • verbose name: All True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT
  • any_true
    True if any data values are True.

    • verbose name: Any True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT

GreaterThan

For each array element, test whether it is greater in data1 than in data2.

This operation returns an array, but you can also wire out the all_true or any_true outputs, which yield a single boolean (true/false) value that indicates whether the test came out true for all elements (or for any element). These outputs can then be wired into nodes that accept booleans, like the IfElse node. Alternatively you can use the All or Any nodes to convert arrays of booleans into a single boolean.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumericOrStr (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: Port
    • value type: object (can be None)
  • all_true
    True if all data values are True.

    • verbose name: All True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT
  • any_true
    True if any data values are True.

    • verbose name: Any True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT

IsInfinite

Return an object of the same type and shape as the data that has, for each element, a boolean value (true/false) indicating whether it was a positive or negative infinity value.

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

IsNan

Return an object of the same type and shape as the data that has, for each element, a boolean value (true/false) indicating whether it was a NaN value (invalid floating-point value, a.k

.a. not a number).

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

LessOrEqual

For each array element in data1, test whether it is less than or equal to the corresponding element in data2.

This operation returns an array, but you can also wire out the all_true or any_true outputs, which yield a single boolean (true/false) value that indicates whether the test came out true for all elements (or for any element). These outputs can then be wired into nodes that accept booleans, like the IfElse node. Alternatively you can use the All or Any nodes to convert arrays of booleans into a single boolean.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumericOrStr (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: Port
    • value type: object (can be None)
  • all_true
    True if all data values are True.

    • verbose name: All True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT
  • any_true
    True if any data values are True.

    • verbose name: Any True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT

LessThan

For each array element, test whether it is less in data1 than in data2.

This operation returns an array, but you can also wire out the all_true or any_true outputs, which yield a single boolean (true/false) value that indicates whether the test came out true for all elements (or for any element). These outputs can then be wired into nodes that accept booleans, like the IfElse node. Alternatively you can use the All or Any nodes to convert arrays of booleans into a single boolean.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumericOrStr (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: Port
    • value type: object (can be None)
  • all_true
    True if all data values are True.

    • verbose name: All True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT
  • any_true
    True if any data values are True.

    • verbose name: Any True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT

Logarithm

Take the logarithm of each element in the data to some base.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • base
    Base of the logarithm. If None is given, the natural logarithm will be used.

    • verbose name: Base
    • default value: None
    • port type: FloatPort
    • value type: float (can be None)

Magnitude

Take the absolute magnitude of each element in the data.

For complex numbers this will be the complex magnitude, and for real numbers it is the absolute value.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Max

Take the maximum of each element in the data and a fixed threshold.

See also Largest for the maximum along an axis.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • threshold
    Threshold for maximum computation. Any value in the data that is smaller than this will be replaced by this value.

    • verbose name: Threshold
    • default value: 0.0
    • port type: FloatPort
    • value type: float (can be None)

Maximum

Take the elementwise maximum of the given data items.

Note that the shape of the arrays must be compatible for all data inputs. Note: the output array will have the same dimension as either input array, and at each position in the output array the value will be the maximum of the corresponding value in the first and the second input.

Version 1.1.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data3
    Input data 3.

    • verbose name: Data3
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data4
    Input data 4.

    • verbose name: Data4
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data5
    Input data 5.

    • verbose name: Data5
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data6
    Input data 6.

    • verbose name: Data6
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data7
    Input data 7.

    • verbose name: Data7
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data8
    Input data 8.

    • verbose name: Data8
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data9
    Input data 9.

    • verbose name: Data9
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data10
    Input data 10.

    • verbose name: Data10
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • dataN
    Additional input data.

    • verbose name: Datan
    • default value: None
    • port type: DataPort
    • value type: list (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Earlier binary forms of these operations used to return the first argument when the second argument was None, but did not do the same in the reverse case. Since n-ary operations are commutative, the new behavior is to return whichever argument was not None in such a case, or more generally to ignore None inputs and operate on the remaining ones. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

Min

Take the minimum of each element in the data and a fixed threshold.

See also Smallest for the minimum along an axis.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • threshold
    Threshold for minimum computation. Any value that is larger than this will be replaced by this value.

    • verbose name: Threshold
    • default value: 0.0
    • port type: FloatPort
    • value type: float (can be None)

Minimum

Take the elementwise minimum of the given data items.

Note that the shape of the arrays must be compatible for all data inputs. Note: the output array will have the same dimension as either input array, and at each position in the output array the value will be the minimum of the corresponding value in the first and the second input.

Version 1.1.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data3
    Input data 3.

    • verbose name: Data3
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data4
    Input data 4.

    • verbose name: Data4
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data5
    Input data 5.

    • verbose name: Data5
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data6
    Input data 6.

    • verbose name: Data6
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data7
    Input data 7.

    • verbose name: Data7
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data8
    Input data 8.

    • verbose name: Data8
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data9
    Input data 9.

    • verbose name: Data9
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data10
    Input data 10.

    • verbose name: Data10
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • dataN
    Additional input data.

    • verbose name: Datan
    • default value: None
    • port type: DataPort
    • value type: list (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Earlier binary forms of these operations used to return the first argument when the second argument was None, but did not do the same in the reverse case. Since n-ary operations are commutative, the new behavior is to return whichever argument was not None in such a case, or more generally to ignore None inputs and operate on the remaining ones. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

Modulo

Calculate the modulus (remainder) of a mod b.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: Port
    • value type: object (can be None)
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

Multiply

Multiply the data in the in the given data items (elementwise).

Note that the shape of the arrays must be compatible for all inputs.

Version 1.1.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data3
    Input data 3.

    • verbose name: Data3
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data4
    Input data 4.

    • verbose name: Data4
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data5
    Input data 5.

    • verbose name: Data5
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data6
    Input data 6.

    • verbose name: Data6
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data7
    Input data 7.

    • verbose name: Data7
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data8
    Input data 8.

    • verbose name: Data8
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data9
    Input data 9.

    • verbose name: Data9
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data10
    Input data 10.

    • verbose name: Data10
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • dataN
    Additional input data.

    • verbose name: Datan
    • default value: None
    • port type: DataPort
    • value type: list (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Earlier binary forms of these operations used to return the first argument when the second argument was None, but did not do the same in the reverse case. Since n-ary operations are commutative, the new behavior is to return whichever argument was not None in such a case, or more generally to ignore None inputs and operate on the remaining ones. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

Negate

Negate each element of the data.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

NotEqualTo

For each array element in data1, test whether it is not equal to the corresponding element in data2.

This operation returns an array, but you can also wire out the all_true or any_true outputs, which yield a single boolean (true/false) value that indicates whether the test came out true for all elements (or for any element). These outputs can then be wired into nodes that accept booleans, like the IfElse node. Alternatively you can use the All or Any nodes to convert arrays of booleans into a single boolean. Tip: if you wish to compare arrays in shape and content (i.e., arrays of different shape will be considered not-equal), you can use the AllEqual node instead.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumericOrStr (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: Port
    • value type: object (can be None)
  • all_true
    True if all data values are True.

    • verbose name: All True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT
  • any_true
    True if any data values are True.

    • verbose name: Any True
    • default value: None
    • port type: DataPort
    • value type: bool (can be None)
    • data direction: OUT

OperateConstant

Add, subtract, multiply or divide each element in the data by a given constant.

Skips marker streams.

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • constant
    Value by which to perform the selected operation on each element of the data.

    • verbose name: Constant
    • default value: 0.0
    • port type: FloatPort
    • value type: float (can be None)
  • operator
    The operator to be performed on the data using the constant.

    • verbose name: Operator
    • default value: add
    • port type: EnumPort
    • value type: str (can be None)
  • constant_first
    When true, the order of the operation is the constant first, element second, i.e .: constant-element (instead of element-constant). This only affects subtract and divide.

    • verbose name: Constant First
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

OperateElementwise

Apply an operation to the data, where the data block of the first and second inputs are operands.

The selected operator will be between the first and second input operands, i.e., data1 * data2. The operation is performed elementwise (each element of the first input is multiplied/divided/added/subtracted by the matching element of the second input). Note that the shape of the data arrays must be the same for both data inputs. If the packets contain multiple streams and restrict_to_same_stream_name is true, the operation will be performed on each pair of streams having the same name. Event streams and empty streams are ignored. This node absorbs the functionality of the Add, Subtract, Multiply, Divide nodes.

Version 0.9.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: IN
  • outdata
    Data to process.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: OUT
  • operator
    The operator to be performed on data1 and data2 operands, in the following order: data1 data2.

    • verbose name: Operator
    • default value: add
    • port type: EnumPort
    • value type: str (can be None)
  • restrict_to_same_stream_name
    If True, this node will only operate on a stream in data1 if it finds a stream with the same name in data2. If set to False, the first signal stream in data1 will be operated on together with the first signal stream in data2. If False and the first input has multiple signal streams, a warning will be displayed and the operation will be ignored.

    • verbose name: Restrict To Same Stream Name
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

Phase

Calculate the phase angle of each element in the data.

This is assuming that elements are complex.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Power

Raise each element in the data to some power (exponent).

The exponent is a fixed constant.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • power
    Exponent. Every element in the data will be raised to this power.

    • verbose name: Exponent
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)

Power2

Raise each element of the data in the first input to a power that is given by the corresponding element in the second input.

Note that the shape of the arrays must be the same for both data inputs; the output array will have the same dimension as either input array.

Version 1.1.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

Reciprocal

Take the reciprocal (inverse) of each element in the data.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ReciprocalSquareRoot

Take the reciprocal square root of each element in the data.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ReplaceNans

Replace all NaN values in the data by a given value.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • value
    Value to replace NaNs with. If this is set to None, the surrounding data will be linearly interpolated providing the data has a time axis.

    • verbose name: Value To Replace Nans With
    • default value: 0.0
    • port type: FloatPort
    • value type: float (can be None)

ReplaceNonfinite

Replace NaN values in the data by 0, and Inf/-Inf values by a small/large number.

Version 2.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • max
    Replace Inf by this value. Inf values will be replaced by this, and -Inf values will be replaced by the negative of this value.

    • verbose name: Max
    • default value: 1e+30
    • port type: FloatPort
    • value type: float (can be None)

ReplaceValues

Replace values in the data, using a mapping of old_value -> new_value.

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: Packet (can be None)
    • data direction: INOUT
  • mapping
    A dictionary of replacement mappings, where each key is the value to replace and each value is its replacement. For example, {np.nan: 0, -1: 10} will replace all nans and -1 in the data by 0 and 10, respectively.

    • verbose name: A Dictionary Of Mapping
    • default value: {}
    • port type: DictPort
    • value type: dict (can be None)

Round

Round each element to a given precision.

This node supports several rounding modes. Note that the "round" mode uses the "round half to even" rule.

More Info...

Version 1.2.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

    • verbose name: Rounding Mode
    • default value: round
    • port type: EnumPort
    • value type: str (can be None)
  • precision
    Number of decimal places to round to. If 0, round to the nearest integer.

    • verbose name: Precision
    • default value: 0
    • port type: IntPort
    • value type: int (can be None)

Scaling

Scale each element of the data by a constant factor.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • factor
    Scaling factor. Each element of the data is scaled by this factor.

    • verbose name: Factor
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)

Shift

Add a given value to each element of the data.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • offset
    Shift offset. This is the value that shall be added to every element of the given data.

    • verbose name: Offset
    • default value: 0.0
    • port type: FloatPort
    • value type: float (can be None)

Sigmoid

Apply a sigmoidal (dampening/squashing) transform to each element in the data.

The transform employed here is a generalization of the function y=1/1+exp(-x)), which includes pre-scaling and pre-shift as well as post-scaling and post-shift constants, which can be used to scale and shift the standard sigmoid function graph horizontally and vertically, following the modified formula: y = vshift + scale * (1/(exp(-slope*(x - hshift)))). This function can be used to ensure that the data lie in a given range, without performing a hard thresholding like the Clamp operation. See also the more... link for more information on the unmodified (standard) sigmoid transform.

More Info...

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • hshift
    Shift before sigmoid transform. Shifts the function graph horizontally.

    • verbose name: Hshift
    • default value: 0.0
    • port type: FloatPort
    • value type: float (can be None)
  • vshift
    Shift after sigmoid transform. Shifts the function graph vertically.

    • verbose name: Vshift
    • default value: 0.0
    • port type: FloatPort
    • value type: float (can be None)
  • scale
    Scaling after sigmoid transform. This scales the function graph vertically.

    • verbose name: Scale
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)
  • slope
    Slope of the middle part of the sigmoidal curve. Larger values mean narrower range of squashing. Also the same as scaling before the sigmoid transform. This scales the function graph horizontally.

    • verbose name: Slope
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)

Sign

Take the sign of each element in the data.

Version 1.1.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Sin

Calculate the sine of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Sinh

Calculate the hyperbolic sine of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Softmax

Apply the softmax function to the given data array.

The softmax normalizes the data so that the sum of the data along the specified axis is 1.0 and each individual data point is between 0.0 and 1.0, yielding what can be interpreted as a probability distribution. Note that the softmax function is not a smoothed version of the max function, but could be more accurately described as a smoothed version of an argmax function that returns the maximum in a one-hot encoded form (i.e., with a 1 at the maximal index and 0 everywhere else). The function is conventionally used in machine learning to normalize a vector of scores generated by some prediction function (e.g., logits) to a categorical probability distribution.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • axis
    Axis along which the data will have the softmax applied. You can also enter the axis label here as in feature.mylabel.

    • verbose name: Axis
    • default value: statistic
    • port type: ComboPort
    • value type: object (can be None)
  • stream
    Stream name on which to operate; if unspecified, all streams containing the specified axis will be modified. Wildcards are supported, so mystream* will operate on all streams starting with mystream.

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

SpecialFunction

Evaluate a mathematical special function elementwise for one or more array operands.

For the arguments used by any given function and their order, refer to below associated URL. The error message also informs you of the number and names of the required operands. The result will be of the highest type of the inputs (Packet, array, list, float).

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data1
    First operand.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Second operand.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data3
    Third operand.

    • verbose name: Data3
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • result
    Output data.

    • verbose name: Result
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • function
    Special function to evaluate. See node documentation for details.

    • verbose name: Function
    • default value: erf
    • port type: EnumPort
    • value type: str (can be None)
  • missing
    Behavior when one of the required operands is None.

    • verbose name: Missing
    • default value: error
    • port type: EnumPort
    • value type: str (can be None)

SquareRoot

Take the square root of each element in the data.

Version 1.2.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Squaring

Square each element in the data.

Version 1.2.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Step

Map the input data through a single interval step function.

Input values that are below a threshold are mapped to one constant value (i.e., 1.0), and values that are above the threshold are mapped to another constant value (i.e., 0.0). One example of using this node would be for converting the p-values coming from the TTest node into a binary (0/1) mask, then feeding the the resulting 0 or 1 values into the Multiply node to threshold data by statistical significance. For multiple interval thresholding, use the Discretize node.

Version 1.4.0

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • below_thresh
    Output level below threshold (or threshold1). Input values that are smaller or equal to the threshold (threshold1) will be mapped to this value.

    • verbose name: Value If Below Threshold
    • default value: 1.0
    • port type: FloatPort
    • value type: float (can be None)
  • above_thresh
    Output level above threshold (or threshold1). Input values that are larger than the threshold (or threshold1) will be mapped to this value.

    • verbose name: Value If Above Threshold
    • default value: 0.0
    • port type: FloatPort
    • value type: float (can be None)
  • threshold
    Threshold value. Values that are smaller than or equal to the threshold will be mapped to the below-threshold constant, and values that are larger will be mapped to the above-threshold constant. Leave empty to perform no thresholding. threshold1 is an alias for this parameter.

    • verbose name: Threshold
    • default value: 0.05
    • port type: FloatPort
    • value type: float (can be None)
  • pass_nan
    If set the nan values will be passed unchanged from input to output data.

    • verbose name: Passthrough Nan
    • default value: False
    • port type: BoolPort
    • value type: bool (can be None)

Subtract

Subtract the data in the second input from the data in the first input (elementwise).

Note that the shape of the arrays must be the same for both data inputs. This node also assumes that the streams have the same name. The new chunk will keep any metadata or instance data from the first input.

Version 1.1.0

Ports/Properties

  • 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)
  • data1
    Input data 1.

    • verbose name: Data1
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • data2
    Input data 2.

    • verbose name: Data2
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • outdata
    Result.

    • verbose name: Outdata
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • verbose
    Verbose output.

    • verbose name: Verbose
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)
  • back_compat
    Backward compatibility mode. Binary operations, used to return the first argument when the second argument was None. However, for better predictability, binary operations now by default return None when either of the two is None. You can use this option to either restore the old behavior ("on"), or set it to "off" to use the new behavior, or use "warn" to have the new behavior but emit a compatibility warning.

    • verbose name: Back Compat
    • default value: warn
    • port type: EnumPort
    • value type: str (can be None)

Tan

Calculate the tangent of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

Tanh

Calculate the hyperbolic tangent of each element in the data.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • data
    Data to process.

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

ToDecibels

Convert the given quantity to decibels.

Version 1.2.2

Ports/Properties

  • 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)
  • data
    Data to process.

    • verbose name: Data
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: INOUT
  • source_measure
    Source measure. Since power values are squared, the conversion formula accounts for that. 'auto' will map to 'amplitude' if the chunk has a Metadata.quantity property that is NOT QuantityNames.power, otherwise it will map to 'power'.

    • verbose name: Source Measure
    • default value: auto
    • port type: EnumPort
    • value type: str (can be None)
  • replace_zeros
    Replace zeros with the smallest possible value (epsilon) to avoid taking the logarithm of zero which would result in -inf.

    • verbose name: Replace Zeros
    • default value: True
    • port type: BoolPort
    • value type: bool (can be None)

Where

Select from one or another array elementwise, depending on an elementwise condition mask.

Generally, the mask, where_true and where_false data should be of the same shape, though where_true and where_false can also be single values in which case that value will be used for each matching value in the mask, or vectors in which case the vector will be broadcast to the shape of the mask. If the where_true and where_false inputs are of different types, the result result will be of the highest type (highest to lowest: Packet, array, list, float, int). This node is functionally equivalent to the "where" operator of the Python Array API (see link) and returns values and not the indices of matching values (like numpy.where(condition)). If the latter is desired (for example, to get the indices of values to then select using SelectRange), use the ArrayNonzero node instead.

More Info...

Version 1.0.0

Ports/Properties

  • 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)
  • mask
    Condition mask.

    • verbose name: Mask
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • where_true
    Data to choose from where condition is true.

    • verbose name: Where True
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • where_false
    Data to choose from where condition is false.

    • verbose name: Where False
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: IN
  • result
    Output data.

    • verbose name: Result
    • default value: None
    • port type: DataPort
    • value type: AnyNumeric (can be None)
    • data direction: OUT
  • missing
    Behavior when the true or false arrays are None.

    • verbose name: Missing
    • default value: error
    • port type: EnumPort
    • value type: str (can be None)