Cross Correlation
- Updated2023-02-17
- 6 minute(s) read
Cross Correlation
Computes the cross correlation of two signals.
.gvi.png?_LANG=enus)
Inputs/Outputs

reset
A Boolean that specifies whether to reset the internal state of the node.
True | Resets the internal state of the node. |
False | Does not reset the internal state of the node. |
This input is available when either of the input sequences is a double-precision, floating-point number.
Default value: False

x
The input signal.
This input supports the following data types.
- Waveform
- 1D array of waveforms
- Double-precision, floating-point number
- 1D array of double-precision, floating-point numbers
- 1D array of complex double-precision, floating-point numbers
- 2D array of double-precision, floating-point numbers

y
The second input signal, which you want to cross correlate with the first input signal.
This input supports the following data types:
- Waveform
- 1D array of waveforms
- Double-precision, floating-point number
- 1D array of double-precision, floating-point numbers
- 1D array of complex double-precision, floating-point numbers
- 2D array of double-precision, floating-point numbers

algorithm
The correlation method to use.
This input is available only if both x and y are arrays or waveforms.
If x and y are small, the direct method typically is faster. If x and y are large, the frequency domain method typically is faster. Additionally, slight numerical differences can exist between the two methods.
direct |
Computes the cross correlation using the direct method of linear correlation. |
frequency domain |
Computes the cross correlation using an FFT-based technique. |
Default value: frequency domain

normalization
The normalization method to use to compute the cross correlation between the two input signals.
This input is available only if both x and y are arrays or waveforms.
none |
Does not apply normalization. |
unbiased |
Applies unbiased normalization. |
biased |
Applies biased normalization. |
Default value: none

sample length x
Length of each set of x-values.
sample length x must be greater than 0.
This input is available only if x is a double-precision, floating-point number.
Default value: 100

sample length y
Length of each set of y-values.
sample length y must be greater than 0.
This input is available only if y is a double-precision, floating-point number.
Default value: 100

error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error

use history data
A Boolean that specifies whether to use the data points before the current block to compute the cross-correlation.
True | Uses the data points before the current block to compute the cross-correlation. |
False | Does not use the data points before the current block to compute the cross-correlation. |
This input is available only if one of the input sequences is a double-precision, floating-point number.
Default value: True

Rxy
Cross correlation of the two input signals.
This output can return the following data types:
- Waveform
- 1D array of waveforms
- 1D array of double-precision, floating-point numbers
- 1D array of complex double-precision, floating-point numbers

error out
Error information.
The node produces this output according to standard error behavior.
Algorithm for Calculating the Cross Correlation
The cross correlation Rxy(t) of the sequences x(t) and y(t) is defined by the following equation:
where the symbol
denotes correlation. h N x M y x yand
Then this node obtains the elements of h using the following equation:
for
The elements of the output sequence Rxy are related to the elements in the sequence h by
for
Because you cannot index arrays with negative numbers, the corresponding cross correlation value at t = 0 is the Nth element of the output sequence Rxy. Therefore, Rxy represents the correlation values that this node shifts N times in indexing.
How This Node Applies Unbiased Normalization
This node applies unbiased normalization as follows:
for j = 0, 1, 2, ..., M + N - 2
where Rxy is the cross correlation between x and y with no normalization. f(j) is:
How This Node Applies Biased Normalization
This node applies biased normalization as follows:
for j = 0, 1, 2, ..., M + N - 2
where Rxy is the cross correlation between x and y with no normalization.