fft_ccfftm - multiple complex-complex 1D FFT's

SYNOPSIS

#include <fft.h> (fixed-format sources)
#include <f90fft.h> (free-format sources)

integer function fft_ccfftm(isign, scale, n1, m, ld1, cdata, iopt)

integer isign
real scale
integer n1
integer m
integer ld1
complex cdata(ld1,m)
integer iopt

DESCRIPTION

The function, "fft_ccfftm", performs multiple complex-to-complex FFT's.

INPUT

The parameter, "isign", specifies the sign of complex exponential. It expects a "1" or "-1"; a value of zero "0" is invalid.

The parameter, "scale", specifies the scale factor to be applied to the data.

The size parameter, "n1", specifies the 1D FFT size. It must be setup as mixed radix values (must be even) in order to allow the fft's to be more efficient. It is recommended to use fft_nrfft5 to calculate this value.

The number of 1D traces parameter, "m", specifies the number of 1D FFT's to do at a time.

The leading dimension parameter, "ld1", specifies the leading dimensions of the complex array. If it is the same as the FFT size, then the routine will be more efficient.

The complex array, "cdata", is the I/O array for the FFT's. This is performed "in place".

The parameter, "iopt", is used to specify any other information that is unique to a specific FFT implementation. Currently, the use is for specifying whether to measure or estimate the FFT's when using FFTW routines. The "fft.h" header defines FFT_MEASURE and FFT_ESTIMATE, besides defining the FFT functions, as integer.

OUTPUT

The fft results are returned in the complex data array and the returned value is zero "0" if successful. A value of "-1" is returned if the arguments are invalid. Otherwise, a value unique to each FFT implementation is returned.

EXAMPLE

      integer :: fft_size, m, fft_flag
      integer :: isign, ier
      real    :: fft_scale
      complex, allocatable :: cdata(:,:)

      fft_size = fft_nrfft5(100)
      m = 10

      allocate(cdata(fft_size, m))

      ...
      fft_flag = FFT_ESTIMATE

      ! forward FFT
      isign = -1
      fft_scale = 1.0D+00/(dble(fft_size))
      ier = fft_ccfftm(isign, fft_scale, fft_size, m, fft_size, cdata, fft_flag)

      ! inverse FFT
      isign = 1
      fft_scale = 1.0
      ier = fft_ccfftm(isign, fft_scale, fft_size, m, fft_size, cdata, fft_flag)

AUTHOR

Phuong Vu, HPC
Jerry Ehlers, EPTG