Fft<T>.ForwardTransform Method

Definition

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

Overload List

ForwardTransform(Vector<T>)	Computes the discrete Fourier transform of a real signal and returns the result.
ForwardTransform(Vector<Complex<T>>)	Computes the discrete Fourier transform of a complex signal and returns the result.
ForwardTransform(ArraySlice<T>, ArraySlice<Complex<T>>)	Computes the discrete Fourier transform of a real signal.
ForwardTransform(ArraySlice<Complex<T>>, ArraySlice<Complex<T>>)	Computes the discrete Fourier transform of a complex signal.
ForwardTransform(DenseVector<T>, ComplexConjugateSignalVector<T>)	Computes the discrete Fourier transform of a real signal.
ForwardTransform(DenseVector<Complex<T>>, DenseVector<Complex<T>>)	Computes the discrete Fourier transform of a complex signal.
ForwardTransform(Vector<T>, Vector<Complex<T>>)	Computes the discrete Fourier transform of a real signal.
ForwardTransform(Vector<Complex<T>>, Vector<Complex<T>>)	Computes the discrete Fourier transform of a complex signal.
ForwardTransform(Vector<T>, Vector<Complex<T>>, RealFftFormat)	Computes the discrete Fourier transform of a real signal.
ForwardTransform(ReadOnlySpan<T>, Int32, Span<Complex<T>>, Int32)	Computes the discrete Fourier transform of a real signal.
ForwardTransform(ReadOnlySpan<Complex<T>>, Int32, Span<Complex<T>>, Int32)	Computes the discrete Fourier transform of a complex signal.

ForwardTransform(Vector<T>)

Computes the discrete Fourier transform of a real signal and returns the result.

public ComplexConjugateSignalVector<T> ForwardTransform(
	Vector<T> input
)

Visual Basic

Public Function ForwardTransform ( 
	input As Vector(Of T)
) As ComplexConjugateSignalVector(Of T)

C++/CLI

public:
ComplexConjugateSignalVector<T>^ ForwardTransform(
	Vector<T>^ input
)

member ForwardTransform : 
        input : Vector<'T> -> ComplexConjugateSignalVector<'T>

Parameters

input Vector<T>: A Double vector containing the input signal.

Return Value

ComplexConjugateSignalVector<T>
A ComplexConjugateSignalVector<T>.

Remarks

The output is stored in a compact format to take advantage of the symmetry properties of a real Fourier transform. Specifically, the return value stores only the first n/2+1 terms of the transformed signal.

Exceptions

ArgumentNullException

input is null.

ForwardTransform(Vector<Complex<T>>)

Computes the discrete Fourier transform of a complex signal and returns the result.

public DenseVector<Complex<T>> ForwardTransform(
	Vector<Complex<T>> input
)

Visual Basic

Public Function ForwardTransform ( 
	input As Vector(Of Complex(Of T))
) As DenseVector(Of Complex(Of T))

C++/CLI

public:
DenseVector<Complex<T>>^ ForwardTransform(
	Vector<Complex<T>>^ input
)

member ForwardTransform : 
        input : Vector<Complex<'T>> -> DenseVector<Complex<'T>>

Parameters

input Vector<Complex<T>>: On input, a complex vector containing the input signal. On return, the forward transform of the input.

Return Value

DenseVector<Complex<T>>

Exceptions

ArgumentNullException

input is null.

ForwardTransform(ArraySlice<T>, ArraySlice<Complex<T>>)

Computes the discrete Fourier transform of a real signal.

public void ForwardTransform(
	ArraySlice<T> input,
	ArraySlice<Complex<T>> output
)

Visual Basic

Public Sub ForwardTransform ( 
	input As ArraySlice(Of T),
	output As ArraySlice(Of Complex(Of T))
)

C++/CLI

public:
void ForwardTransform(
	ArraySlice<T> input, 
	ArraySlice<Complex<T>> output
)

member ForwardTransform : 
        input : ArraySlice<'T> * 
        output : ArraySlice<Complex<'T>> -> unit

Parameters

input ArraySlice<T>: A real array slice containing the input signal.
output ArraySlice<Complex<T>>: A complex array slice to hold the transformed signal.

Remarks

The output is stored in a compact format to take advantage of the symmetry properties of a real Fourier transform. Specifically, output contains only the first n/2+1 terms of the transformed signal. Use the complex ArraySlice<T> class to obtain a complex vector that represents the complete signal.

Exceptions

InvalidOperationException

The Fourier transform implementation is not configured to accept real input.

ArgumentNullException

input is null.

-or-

output is null.

DimensionMismatchException

The length of input does not equal the length of output.

ForwardTransform(ArraySlice<Complex<T>>, ArraySlice<Complex<T>>)

Computes the discrete Fourier transform of a complex signal.

public void ForwardTransform(
	ArraySlice<Complex<T>> input,
	ArraySlice<Complex<T>> output
)

Visual Basic

Public Sub ForwardTransform ( 
	input As ArraySlice(Of Complex(Of T)),
	output As ArraySlice(Of Complex(Of T))
)

C++/CLI

public:
void ForwardTransform(
	ArraySlice<Complex<T>> input, 
	ArraySlice<Complex<T>> output
)

member ForwardTransform : 
        input : ArraySlice<Complex<'T>> * 
        output : ArraySlice<Complex<'T>> -> unit

Parameters

input ArraySlice<Complex<T>>: A complex ArraySlice<T> containing the input signal.
output ArraySlice<Complex<T>>: A complex ArraySlice<T> to hold the transformed signal.

Exceptions

ArgumentNullException

input is null.

-or-

output is null.

DimensionMismatchException

The length of input does not equal the length of output.

ForwardTransform(DenseVector<T>, ComplexConjugateSignalVector<T>)

Computes the discrete Fourier transform of a real signal.

public void ForwardTransform(
	DenseVector<T> input,
	ComplexConjugateSignalVector<T> output
)

Visual Basic

Public Sub ForwardTransform ( 
	input As DenseVector(Of T),
	output As ComplexConjugateSignalVector(Of T)
)

C++/CLI

public:
void ForwardTransform(
	DenseVector<T>^ input, 
	ComplexConjugateSignalVector<T>^ output
)

member ForwardTransform : 
        input : DenseVector<'T> * 
        output : ComplexConjugateSignalVector<'T> -> unit

Parameters

input DenseVector<T>: A Double vector containing the input signal.
output ComplexConjugateSignalVector<T>: A complex vector to hold the transformed signal.

Remarks

The output is stored in a compact format to take advantage of the symmetry properties of a real Fourier transform. Specifically, output contains only the first n/2+1 terms of the transformed signal. Use the ComplexConjugateSignalVector<T> class to obtain a complex vector that represents the complete signal.

Exceptions

InvalidOperationException

The Fourier transform implementation is not configured to accept real input.

ArgumentNullException

input is null.

-or-

output is null.

DimensionMismatchException

The length of input does not equal the length of output.

ForwardTransform(DenseVector<Complex<T>>, DenseVector<Complex<T>>)

Computes the discrete Fourier transform of a complex signal.

public void ForwardTransform(
	DenseVector<Complex<T>> input,
	DenseVector<Complex<T>> output
)

Visual Basic

Public Sub ForwardTransform ( 
	input As DenseVector(Of Complex(Of T)),
	output As DenseVector(Of Complex(Of T))
)

C++/CLI

public:
void ForwardTransform(
	DenseVector<Complex<T>>^ input, 
	DenseVector<Complex<T>>^ output
)

member ForwardTransform : 
        input : DenseVector<Complex<'T>> * 
        output : DenseVector<Complex<'T>> -> unit

Parameters

input DenseVector<Complex<T>>: A dense complex vector containing the input signal.
output DenseVector<Complex<T>>: A dense complex vector to hold the transformed signal.

Exceptions

ArgumentNullException

input is null.

-or-

output is null.

DimensionMismatchException

The length of input does not equal the length of output.

ForwardTransform(Vector<T>, Vector<Complex<T>>)

Computes the discrete Fourier transform of a real signal.

public void ForwardTransform(
	Vector<T> input,
	Vector<Complex<T>> output
)

Visual Basic

Public Sub ForwardTransform ( 
	input As Vector(Of T),
	output As Vector(Of Complex(Of T))
)

C++/CLI

public:
void ForwardTransform(
	Vector<T>^ input, 
	Vector<Complex<T>>^ output
)

member ForwardTransform : 
        input : Vector<'T> * 
        output : Vector<Complex<'T>> -> unit

Parameters

input Vector<T>: A Double vector containing the input signal.
output Vector<Complex<T>>: A complex vector to hold the transformed signal.

Remarks

The output is stored in a compact format to take advantage of the symmetry properties of a real Fourier transform. Specifically, output contains only the first n/2+1 terms of the transformed signal. Use the ComplexConjugateSignalVector<T> class to obtain a complex vector that represents the complete signal.

Exceptions

ArgumentNullException

input is null.

-or-

output is null.

ForwardTransform(Vector<Complex<T>>, Vector<Complex<T>>)

Computes the discrete Fourier transform of a complex signal.

public void ForwardTransform(
	Vector<Complex<T>> input,
	Vector<Complex<T>> output
)

Visual Basic

Public Sub ForwardTransform ( 
	input As Vector(Of Complex(Of T)),
	output As Vector(Of Complex(Of T))
)

C++/CLI

public:
void ForwardTransform(
	Vector<Complex<T>>^ input, 
	Vector<Complex<T>>^ output
)

member ForwardTransform : 
        input : Vector<Complex<'T>> * 
        output : Vector<Complex<'T>> -> unit

Parameters

input Vector<Complex<T>>: A complex vector containing the input signal.
output Vector<Complex<T>>: A complex vector to hold the transformed signal.

Exceptions

ArgumentNullException

input is null.

-or-

output is null.

ForwardTransform(Vector<T>, Vector<Complex<T>>, RealFftFormat)

Computes the discrete Fourier transform of a real signal.

public void ForwardTransform(
	Vector<T> input,
	Vector<Complex<T>> output,
	RealFftFormat outputFormat
)

Visual Basic

Public Sub ForwardTransform ( 
	input As Vector(Of T),
	output As Vector(Of Complex(Of T)),
	outputFormat As RealFftFormat
)

C++/CLI

public:
void ForwardTransform(
	Vector<T>^ input, 
	Vector<Complex<T>>^ output, 
	RealFftFormat outputFormat
)

member ForwardTransform : 
        input : Vector<'T> * 
        output : Vector<Complex<'T>> * 
        outputFormat : RealFftFormat -> unit

Parameters

input Vector<T>: A Double vector containing the input signal.
output Vector<Complex<T>>: A complex vector to hold the transformed signal.
outputFormat RealFftFormat: A RealFftFormat value that specifies whether to return a one-sided or a two-sided transform.

Remarks

Use this method to compute the Fourier transform of a real signal. The outputFormat specifies whether the return value should contain the full complex transform (TwoSided), or only the first n/2+1 terms of the transformed signal (OneSided), where n is the length of the transform.

Exceptions

InvalidOperationException	The Fourier transform implementation is not configured to accept real input.
ArgumentNullException	input is null. -or- output is null.
ArgumentOutOfRangeException	outputFormat is not a valid RealFftFormat value.
DimensionMismatchException	outputFormat equals OneSided and the length of output does not equal half the length of input plus one. -or- outputFormat equals TwoSided and the length of input does not equal the length of output.

ForwardTransform(ReadOnlySpan<T>, Int32, Span<Complex<T>>, Int32)

Computes the discrete Fourier transform of a real signal.

public abstract void ForwardTransform(
	ReadOnlySpan<T> input,
	int inputStride,
	Span<Complex<T>> output,
	int outputStride
)

Visual Basic

Public MustOverride Sub ForwardTransform ( 
	input As ReadOnlySpan(Of T),
	inputStride As Integer,
	output As Span(Of Complex(Of T)),
	outputStride As Integer
)

C++/CLI

public:
virtual void ForwardTransform(
	ReadOnlySpan<T> input, 
	int inputStride, 
	Span<Complex<T>> output, 
	int outputStride
) abstract

abstract ForwardTransform : 
        input : ReadOnlySpan<'T> * 
        inputStride : int * 
        output : Span<Complex<'T>> * 
        outputStride : int -> unit

Parameters

input ReadOnlySpan<T>: A real span containing the input signal.
inputStride Int32: The distance between successive elements in input.
output Span<Complex<T>>: A complex span to hold the transformed signal.
outputStride Int32: The distance between successive elements in output.

Remarks

The output is stored in a compact format to take advantage of the symmetry properties of a real Fourier transform. Specifically, output contains only the first n/2+1 terms of the transformed signal. Use the complex Span<T> class to obtain a complex vector that represents the complete signal.

Exceptions

InvalidOperationException

The Fourier transform implementation is not configured to accept real input.

ArgumentNullException

input is null.

-or-

output is null.

DimensionMismatchException

The length of input does not equal the length of output.

ForwardTransform(ReadOnlySpan<Complex<T>>, Int32, Span<Complex<T>>, Int32)

Computes the discrete Fourier transform of a complex signal.

public abstract void ForwardTransform(
	ReadOnlySpan<Complex<T>> input,
	int inputStride,
	Span<Complex<T>> output,
	int outputStride
)

Visual Basic

Public MustOverride Sub ForwardTransform ( 
	input As ReadOnlySpan(Of Complex(Of T)),
	inputStride As Integer,
	output As Span(Of Complex(Of T)),
	outputStride As Integer
)

C++/CLI

public:
virtual void ForwardTransform(
	ReadOnlySpan<Complex<T>> input, 
	int inputStride, 
	Span<Complex<T>> output, 
	int outputStride
) abstract

abstract ForwardTransform : 
        input : ReadOnlySpan<Complex<'T>> * 
        inputStride : int * 
        output : Span<Complex<'T>> * 
        outputStride : int -> unit

Parameters

input ReadOnlySpan<Complex<T>>: A complex Span<T> containing the input signal.
inputStride Int32: The distance between successive elements in input.
output Span<Complex<T>>: A complex Span<T> to hold the transformed signal.
outputStride Int32: The distance between successive elements in output.

Exceptions

ArgumentNullException

input is null.

-or-

output is null.

DimensionMismatchException

The length of input does not equal the length of output.

Fft<T>.ForwardTransform Method

Definition

Overload List

ForwardTransform(Vector<T>)

Parameters

Return Value

Remarks

Exceptions

ForwardTransform(Vector<Complex<T>>)

Parameters

Return Value

Exceptions

ForwardTransform(ArraySlice<T>, ArraySlice<Complex<T>>)

Parameters

Remarks

Exceptions

ForwardTransform(ArraySlice<Complex<T>>, ArraySlice<Complex<T>>)

Parameters

Exceptions

ForwardTransform(DenseVector<T>, ComplexConjugateSignalVector<T>)

Parameters

Remarks

Exceptions

ForwardTransform(DenseVector<Complex<T>>, DenseVector<Complex<T>>)

Parameters

Exceptions

ForwardTransform(Vector<T>, Vector<Complex<T>>)

Parameters

Remarks

Exceptions

ForwardTransform(Vector<Complex<T>>, Vector<Complex<T>>)

Parameters

Exceptions

ForwardTransform(Vector<T>, Vector<Complex<T>>, RealFftFormat)

Parameters

Remarks

Exceptions

ForwardTransform(ReadOnlySpan<T>, Int32, Span<Complex<T>>, Int32)

Parameters

Remarks

Exceptions

ForwardTransform(ReadOnlySpan<Complex<T>>, Int32, Span<Complex<T>>, Int32)

Parameters

Exceptions

See Also

Reference