Fft2D<T>.ForwardTransform Method

Definition

Namespace: Extreme.Mathematics.SignalProcessing
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

ForwardTransform(Matrix<T>)	Computes the discrete Fourier transform of a real signal and returns the result.
ForwardTransform(Matrix<Complex<T>>)	Computes the discrete Fourier transform of a complex signal and returns the result.
ForwardTransform(Array2D<T>, Array2D<Complex<T>>)	Computes the discrete Fourier transform of a real signal.
ForwardTransform(Array2D<Complex<T>>, Array2D<Complex<T>>)	Computes the discrete Fourier transform of a complex signal.
ForwardTransform(DenseMatrix<T>, ComplexConjugateSignalMatrix<T>)	Computes the discrete Fourier transform of a real signal.
ForwardTransform(DenseMatrix<Complex<T>>, DenseMatrix<Complex<T>>)	Computes the discrete Fourier transform of a complex signal.
ForwardTransform(Matrix<T>, Matrix<Complex<T>>)	Computes the discrete Fourier transform of a real signal.
ForwardTransform(Matrix<Complex<T>>, Matrix<Complex<T>>)	Computes the discrete Fourier transform of a complex signal.
ForwardTransform(Matrix<T>, Matrix<Complex<T>>, RealFftFormat)	Computes the discrete Fourier transform of a real signal.

ForwardTransform(Matrix<T>)

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

public ComplexConjugateSignalMatrix<T> ForwardTransform(
	Matrix<T> input
)

Visual Basic

Public Function ForwardTransform ( 
	input As Matrix(Of T)
) As ComplexConjugateSignalMatrix(Of T)

C++/CLI

public:
ComplexConjugateSignalMatrix<T>^ ForwardTransform(
	Matrix<T>^ input
)

member ForwardTransform : 
        input : Matrix<'T> -> ComplexConjugateSignalMatrix<'T>

Parameters

input Matrix<T>: A Double matrix containing the input signal.

Return Value

ComplexConjugateSignalMatrix<T>
A ComplexConjugateSignalMatrix<T>.

Remarks

The output is stored in a compact format to take advantage of the symmetry properties of a real Fourier transform.

Exceptions

ArgumentNullException

input is null.

ForwardTransform(Matrix<Complex<T>>)

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

public DenseMatrix<Complex<T>> ForwardTransform(
	Matrix<Complex<T>> input
)

Visual Basic

Public Function ForwardTransform ( 
	input As Matrix(Of Complex(Of T))
) As DenseMatrix(Of Complex(Of T))

C++/CLI

public:
DenseMatrix<Complex<T>>^ ForwardTransform(
	Matrix<Complex<T>>^ input
)

member ForwardTransform : 
        input : Matrix<Complex<'T>> -> DenseMatrix<Complex<'T>>

Parameters

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

Return Value

DenseMatrix<Complex<T>>

Exceptions

ArgumentNullException

input is null.

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

Computes the discrete Fourier transform of a real signal.

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

Visual Basic

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

C++/CLI

public:
virtual void ForwardTransform(
	Array2D<T> input, 
	Array2D<Complex<T>> output
) abstract

abstract ForwardTransform : 
        input : Array2D<'T> * 
        output : Array2D<Complex<'T>> -> unit

Parameters

input Array2D<T>: A real 2D array containing the input signal.
output Array2D<Complex<T>>: A complex 2D array 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.

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(Array2D<Complex<T>>, Array2D<Complex<T>>)

Computes the discrete Fourier transform of a complex signal.

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

Visual Basic

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

C++/CLI

public:
virtual void ForwardTransform(
	Array2D<Complex<T>> input, 
	Array2D<Complex<T>> output
) abstract

abstract ForwardTransform : 
        input : Array2D<Complex<'T>> * 
        output : Array2D<Complex<'T>> -> unit

Parameters

input Array2D<Complex<T>>: A complex 2D array containing the input signal.
output Array2D<Complex<T>>: A complex 2D array 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(DenseMatrix<T>, ComplexConjugateSignalMatrix<T>)

Computes the discrete Fourier transform of a real signal.

public void ForwardTransform(
	DenseMatrix<T> input,
	ComplexConjugateSignalMatrix<T> output
)

Visual Basic

Public Sub ForwardTransform ( 
	input As DenseMatrix(Of T),
	output As ComplexConjugateSignalMatrix(Of T)
)

C++/CLI

public:
void ForwardTransform(
	DenseMatrix<T>^ input, 
	ComplexConjugateSignalMatrix<T>^ output
)

member ForwardTransform : 
        input : DenseMatrix<'T> * 
        output : ComplexConjugateSignalMatrix<'T> -> unit

Parameters

input DenseMatrix<T>: A Double matrix containing the input signal.
output ComplexConjugateSignalMatrix<T>: A complex matrix 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 ComplexConjugateSignalMatrix<T> class to obtain a complex matrix 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(DenseMatrix<Complex<T>>, DenseMatrix<Complex<T>>)

Computes the discrete Fourier transform of a complex signal.

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

Visual Basic

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

C++/CLI

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

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

Parameters

input DenseMatrix<Complex<T>>: A complex dense matrix containing the input signal.
output DenseMatrix<Complex<T>>: A complex dense matrix 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(Matrix<T>, Matrix<Complex<T>>)

Computes the discrete Fourier transform of a real signal.

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

Visual Basic

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

C++/CLI

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

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

Parameters

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

Remarks

Exceptions

ArgumentNullException

input is null.

-or-

output is null.

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

Computes the discrete Fourier transform of a complex signal.

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

Visual Basic

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

C++/CLI

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

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

Parameters

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

Exceptions

ArgumentNullException

input is null.

-or-

output is null.

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

Computes the discrete Fourier transform of a real signal.

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

Visual Basic

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

C++/CLI

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

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

Parameters

input Matrix<T>: A Double matrix containing the input signal.
output Matrix<Complex<T>>: A complex matrix 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.

Fft2D<T>.ForwardTransform Method

Definition

Overload List

ForwardTransform(Matrix<T>)

Parameters

Return Value

Remarks

Exceptions

ForwardTransform(Matrix<Complex<T>>)

Parameters

Return Value

Exceptions

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

Parameters

Remarks

Exceptions

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

Parameters

Exceptions

ForwardTransform(DenseMatrix<T>, ComplexConjugateSignalMatrix<T>)

Parameters

Remarks

Exceptions

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

Parameters

Exceptions

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

Parameters

Remarks

Exceptions

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

Parameters

Exceptions

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

Parameters

Remarks

Exceptions

See Also

Reference