KernelProcessor<T>.Correlate Method

Definition

Namespace: Numerics.NET.SignalProcessing
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.0.0

Overload List

Correlate(Vector<T>)	Computes the cross-correlation of a vector with the stored kernel (allocating).
Correlate(ReadOnlySpan<T>, Span<T>)	Computes the cross-correlation of a signal with the stored kernel.
Correlate(Vector<T>, Vector<T>)	Computes the cross-correlation of a vector with the stored kernel (non-allocating).
Correlate(Int32, ReadOnlySpan<T>, Int32, Int32, Span<T>, Int32)	Computes the cross-correlation of a signal with the stored kernel.

Correlate(Vector<T>)

Computes the cross-correlation of a vector with the stored kernel (allocating).

public Vector<T> Correlate(
	Vector<T> signal
)

Visual Basic

Public Function Correlate ( 
	signal As Vector(Of T)
) As Vector(Of T)

C++/CLI

public:
Vector<T>^ Correlate(
	Vector<T>^ signal
)

member Correlate : 
        signal : Vector<'T> -> Vector<'T>

Parameters

signal Vector<T>: The input signal vector.

Return Value

Vector<T>
A vector containing the correlation result.

Correlate(ReadOnlySpan<T>, Span<T>)

Computes the cross-correlation of a signal with the stored kernel.

public void Correlate(
	ReadOnlySpan<T> signal,
	Span<T> result
)

Visual Basic

Public Sub Correlate ( 
	signal As ReadOnlySpan(Of T),
	result As Span(Of T)
)

C++/CLI

public:
void Correlate(
	ReadOnlySpan<T> signal, 
	Span<T> result
)

member Correlate : 
        signal : ReadOnlySpan<'T> * 
        result : Span<'T> -> unit

Parameters

signal ReadOnlySpan<T>: The input signal.
result Span<T>: The output span to hold the correlation result.

Correlate(Vector<T>, Vector<T>)

Computes the cross-correlation of a vector with the stored kernel (non-allocating).

public void Correlate(
	Vector<T> signal,
	Vector<T> output
)

Visual Basic

Public Sub Correlate ( 
	signal As Vector(Of T),
	output As Vector(Of T)
)

C++/CLI

public:
void Correlate(
	Vector<T>^ signal, 
	Vector<T>^ output
)

member Correlate : 
        signal : Vector<'T> * 
        output : Vector<'T> -> unit

Parameters

signal Vector<T>: The input signal vector.
output Vector<T>: The output vector to hold the correlation result.

Correlate(Int32, ReadOnlySpan<T>, Int32, Int32, Span<T>, Int32)

Computes the cross-correlation of a signal with the stored kernel.

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

Visual Basic

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

C++/CLI

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

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

Parameters

signalLength Int32: The length of the signal.
signal ReadOnlySpan<T>: The input signal.
signalStride Int32: The stride between successive elements in the signal.
resultLength Int32: The length of the result.
result Span<T>: The output span to hold the correlation result.
resultStride Int32: The stride between successive elements in the result.

KernelProcessor<T>.Correlate Method

Definition

Overload List

Correlate(Vector<T>)

Parameters

Return Value

Correlate(ReadOnlySpan<T>, Span<T>)

Parameters

Correlate(Vector<T>, Vector<T>)

Parameters

Correlate(Int32, ReadOnlySpan<T>, Int32, Int32, Span<T>, Int32)

Parameters

See Also

Reference