ComplexKernelProcessor<T>.Correlate Method

public override void Correlate(
	int signalLength,
	ReadOnlySpan<Complex<T>> signal,
	int signalStride,
	int resultLength,
	Span<Complex<T>> result,
	int resultStride
)

Public Overrides Sub Correlate ( 
	signalLength As Integer,
	signal As ReadOnlySpan(Of Complex(Of T)),
	signalStride As Integer,
	resultLength As Integer,
	result As Span(Of Complex(Of T)),
	resultStride As Integer
)

public:
virtual void Correlate(
	int signalLength, 
	ReadOnlySpan<Complex<T>> signal, 
	int signalStride, 
	int resultLength, 
	Span<Complex<T>> result, 
	int resultStride
) override

abstract Correlate : 
        signalLength : int * 
        signal : ReadOnlySpan<Complex<'T>> * 
        signalStride : int * 
        resultLength : int * 
        result : Span<Complex<'T>> * 
        resultStride : int -> unit 
override Correlate : 
        signalLength : int * 
        signal : ReadOnlySpan<Complex<'T>> * 
        signalStride : int * 
        resultLength : int * 
        result : Span<Complex<'T>> * 
        resultStride : int -> unit 

Parameters

signalLength  Int32

The length of the input signal.

signal  ReadOnlySpan<Complex<T>>

A read-only span containing the complex input signal.

signalStride  Int32

The stride between successive elements in the signal. Use 1 for contiguous data.

resultLength  Int32

The expected length of the result (should match GetOutputLength(Int32)).

result  Span<Complex<T>>

A span to store the correlation result. Must have capacity for at least resultLength elements.

resultStride  Int32

The stride between successive elements in the result. Use 1 for contiguous output.

Complex correlation computes: y[n] = Σ_m x[n - (m - a)] · conj(h[m]), where a is the anchor index and conj() denotes complex conjugation. This operation is commonly used for template matching and signal similarity measurement in the complex domain.

The kernel conjugation is applied once at the start of the operation, not repeated for each output sample, ensuring optimal performance.

Reference