Skip to content

← signal_processing package

PeakAmplitude

Find the amplitude of the tallest peak along an axis.

This node finds the largest element along an axis and outputs the value of that element along the axis (and if the data has other axes, e.g., channels, then for each channel/etc the amplitude is computed separately). One can optionally find the smallest element (i.e., negative peak), or find either the positive or negative peak (whichever has the greater absolute value). The chosen axis will be replaced by a one-element feature axis with the name 'peak_amplitude'. Version 1.1.0

Ports/Properties

data

Data to process.

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

axis

Axis along which to find the peak. This axis will drop out of the data and be replaced by a one-element feature axis.

  • verbose name: Find Peak Along Axis
  • default value: time
  • port type: ComboPort
  • value type: str (can be None)

negative

Apply to negative peaks. If checked, the smallest element will be searched, instead of the largest.

  • verbose name: Find Negative Peaks
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

direction

Find the positive peaks, negative peaks, or either.

  • verbose name: Direction
  • default value: positive
  • port type: EnumPort
  • value type: str (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)