• COMPUTE THE CROSS CORRELATION OF TWO CURVES*

Computes the cross-correlation between two input curves, returning a new curve that expresses the similarity of the two signals as a function of lag. Use this worker to measure time-delay or phase offset between a pair of time-history or signal curves.

When to use

Classification: process.

Tagged: cross_correlation, curve_pair, digitize, lag, signal_processing, sync.

Inputs

Label ID Type Default Required Description
Curve 1 curve1 vector   Base (reference) curve used as the primary signal in the cross-correlation; accepts a time-history or any ordered x-y vector.
Curve 2 curve2 vector   Second curve correlated against Curve 1; must share the same physical quantity/axis units as Curve 1.
Return Type sync_type float none   Pre-processing synchronisation applied to the two curves before correlation: ‘none’ uses raw data as-is, ‘unify’ resamples both curves onto a common x-axis, ‘digitize’ resamples to a fixed number of points set by Digitize Points; defaults to ‘none’.
Digitize Points numberof_pointsto_digitize scalar 0   Number of evenly-spaced points to resample each curve to when sync_type is ‘digitize’; ignored for other sync types; defaults to 100.
Lag Max lag_max scalar 0   Maximum lag (in index steps or x-axis units) over which cross-correlation is computed; leave at 0 (default) to use the full available lag range.

Outputs

Label ID Type Description
curves_cross_correlation_output_1 curves_cross_correlation_output_1 vector Resulting cross-correlation curve where the x-axis represents lag values and the y-axis represents the normalised or raw correlation coefficient at each lag.

Disciplines

  • data.curve.pair
  • data.signal_processing

Runnable example

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: /api/workflow/example?id=curves_cross_correlation


Auto-generated from transformation schema. Worker id: curves_cross_correlation. Schema hash: 5c2e7b93b81a. Hand-curated docs in workerexamples/ override this page when present.