﻿ILMath.fftn Method (InArray(complex), UInt32[])

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development

Note: This API is now obsolete.

Fast fourier transform (n-D, specific size)

[ILNumerics Computing Engine]

Namespace:  ILNumerics
Assembly:  ILNumerics.Computing (in ILNumerics.Computing.dll) Version: 5.5.0.0 (5.5.7503.3146)
Syntax

```[ObsoleteAttribute("Use fftn(InArray<T> A, InArray<uint> dims) instead! The function ILMath.vector<T>() can be used to replace 'params' arguments.")]
public static RetArray<complex> fftn(
InArray<complex> A,
params uint[] dims
)```

#### Parameters

A
Type: ILNumericsInArraycomplex
Tnput array, n-D
dims
Type: SystemUInt32
Transformation lengths, specifies the length of the dimensions for the transformation array. The length of dims must be > or equal to the number of dimensions of A. For elements in dim being smaller than corresponding dimension length in A, the dimensions will be truncated, otherwise zeros will be padded.

#### Return Value

Type: RetArraycomplex
Transformation result of size specified by 'dims' parameter
Exceptions

ExceptionCondition
ArgumentExceptionis thrown if the dim parameter is null, its length is smaller then the number of dimensions of A or any element of dims is non-negative
Remarks

The n-dimensional transformation is computed for the n-dimensional array A. Before the transform, the input is resized according to the 'dims' parameter. Dimensions larger than corresponding entries in 'dim' are truncated, dimensions smaller than corresponding entries in 'dim' are zero padded.

The n-dimensional transformation is equivalent to repeatedly (inplace) computing one dimensional transformations along all dimensions of A. However, using this function may be of magnitudes faster than using 1D transformations. This depends on the algorithm and API provided by the underlying native library.

The forward fourier transform and the inverse fourier transform of a given data array A are mathematically equivalent. It's only a scaling factor which is needed to make sure, A equals ifft(fft(A)). That scaling is introduced in the inverse transform.

The transformation is computed by use of the native library which currently is set up for your processor and OS version. The underlying library is automatically choosen at ILNumerics startup and accessed via the static member ILMath.FFT. See the online documentation for more details in how to tune/configure and select dedicated native libraries.

[ILNumerics Computing Engine]