Skip to content

← signal_processing package

CenterOfMass

Find the center of mass or centroid along an axis.

For data with a prominent peak, this can be similar to the peak position along the axis (e.g., in seconds or Hz), and for multiple peaks, the result will lie in between the peaks in contrast to peak finding. The chosen axis will generally be replaced by a one-element feature axis. This uses the absolute values of the data as the weights for calculating the mass. One can also optionally account for the delay of previous filter nodes, to the extent that the data is annotated with it. Version 1.0.0

Ports/Properties

data

Data to process.

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

axis

Axis along which to find the centroid. 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)

subtract_filter_delay

Subtract filter delay (time axis only). Note that this is most reliable when used with only linear-phase filters (e.g., FIR filter without minimum phase option), since otherwise the delay will depend on the frequency content of the signal.

  • verbose name: Subtract Filter Delay
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

update_on_streaming

Update on streaming data. If enabled (default), then this node will update its output measure on every chunk, whether it is marked as streaming or not. If False, then it will only update on non-streaming, chunks, such as calibration data.

  • verbose name: Update On Streaming Data
  • default value: True
  • 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)