Skip to content

← formatting package

GetAxisMask

Identifies which slices meet criteria parameters and outputs the result as a mask packet.

Only the first chunk with the axis_type is processed; See ExtractStreams. The mask packet can then be used by ApplyAxisMask to mask out slices along the specified dimension, in a packet with one or more streams with a matching axis. These nodes can be used to slice out trials with bad data. Version 1.0.0

Ports/Properties

data

Data to process.

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

mask

Output mask.

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

comparison_data

Optionally compare input data to this packet. Any len()>1 axes must match input data exactly.

  • verbose name: Comparison Data
  • default value: None
  • port type: DataPort
  • value type: Packet (can be None)
  • data direction: IN

axis_type

The axis along which to evaluate the criteria. A specific axis can be specified using axis.mylabel syntax.

  • verbose name: Axis Type
  • default value: instance
  • port type: ComboPort
  • value type: str (can be None)

comparison_value

Value to compare data to if comparison_data not provided. Default -np.inf and greater_equal will eliminate nan trials.

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

comparison_operator

  • verbose name: Comparison Operator
  • default value: greater_equal
  • port type: EnumPort
  • value type: str (can be None)

dimension_operator

When input chunk is multidimensional, this operation will be applied to the result of the comparison across all other axes.

  • verbose name: Dimension Operator
  • default value: all
  • port type: EnumPort
  • value type: str (can be None)

invert_selection

If set then the resulting mask will be inverted.

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

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)