CxFFT2D

Advanced Analysis Library Only

AnalysisLibErrType CxFFT2D (void *timeDomainSignal, int numberOfRows, int numberOfColumns, int numberOfRowsForFFT, int numberOfColumnsForFFT, int shift, void *fft);

Purpose

Computes the 2D Fast Fourier Transform (FFT) of a complex time-domain signal.

Parameters

Input
Name Type Description
timeDomainSignal numeric array The complex time-domain signal.
numberOfRows integer The number of rows in timeDomainSignal.
numberOfColumns integer The number of columns in timeDomainSignal.
numberOfRowsForFFT integer The number of rows on which to perform the FFT. If numberOfRowsForFFT is greater than numberOfRows, this function pads timeDomainSignal with zeros to match numberOfRowsForFFT. If numberOfRowsForFFT is less than numberOfRows, this function uses only the leading numberOfRowsForFFT rows to perform the FFT. If numberOfRowsForFFT is less than one, this function uses numberOfRows as numberOfRowsForFFT.
numberOfColumnsForFFT integer The number of columns on which to perform the FFT. If numberOfColumnsForFFT is greater than numberOfColumns, this function pads timeDomainSignal with zeros to match numberOfColumnsForFFT. If numberOfColumnsForFFT is less than numberOfColumns, this function uses only the leading numberOfColumnsForFFT columns to perform the FFT. If numberOfColumnsForFFT is less than one, this function uses numberOfColumns as numberOfColumnsForFFT.
shift integer Specifies whether to shift the DC component to the center of fft. shift must be one of the following values:
  • FALSE (0): Ordinary FFT. The first element of fft is the DC component.
  • TRUE (1): DC-centered FFT.
Output
Name Type Description
fft numeric array The 2D FFT of the complex time-domain signal.

Return Value

Name Type Description
status AnalysisLibErrType A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants.