kml_fft(f/h)_plan_dft_2d
建立单个连续数据序列2维C2C变换的plan。
接口定义
C interface:
kml_fft_plan kml_fft_plan_dft_2d(int n0, int n1, kml_fft_complex *in, kml_fft_complex *out, int sign, unsigned flags);
kml_fftf_plan kml_fftf_plan_dft_2d(int n0, int n1, kml_fftf_complex *in, kml_fftf_complex *out, int sign, unsigned flags);
kml_ffth_plan kml_ffth_plan_dft_2d(int n0, int n1, kml_ffth_complex *in, kml_ffth_complex *out, int sign, unsigned flags);
Fortran interface:
RES = KML_FFT_PLAN_DFT_2D(N0, N1, IN, OUT, SIGN, FLAGS);
RES = KML_FFTF_PLAN_DFT_2D(N0, N1, IN, OUT, SIGN, FLAGS);
RES = KML_FFTH_PLAN_DFT_2D(N0, N1, IN, OUT, SIGN, FLAGS);
返回值
函数返回一个kml_fft(f/h)_plan类型的结构体指针。将该对象作为参数传入kml_fft(f/h)_execute函数中使用,将对当前提供的输入in和输出out执行FFT变换;另外,也可以通过将该对象作为参数传入kml_fft(f/h)_execute_dft函数中以对新的输入in和输出out执行FFT变换。
如果函数返回非空指针,则表示plan执行成功,否则表示执行失败。
参数
| 参数名 | 数据类型 | 描述 | 输入/输出 | 
|---|---|---|---|
| n0 | int | 输入FFT序列第一维的大小,约束:n0≥1。 | 输入 | 
| n1 | int | 输入FFT序列第二维的大小,约束:n1≥1。 | 输入 | 
| in | 
 | 输入待变换的数据。 | 输入 | 
| out | 
 | 输出快速傅里叶变换后的数据。 | 输出 | 
| sign | int | 描述正向变换或反向变换。 
 | 输入 | 
| flags | unsigned int | planning选项,描述ESTIMATE模式或PATIENT模式。 KML_FFT_ESTIMATE:ESTIMATE模式 KML_FFT_PATIENT:PATIENT模式 | 输入 | 
依赖
C: "kfft.h"
示例
C interface:
    int n0 = 2; 
    int n1 = 3; 
    double init[6][2] = {{120, 0}, {8, 8}, {0, 0}, {0, 16}, {0, 16}, {-8, 8}}; 
    kml_fft_complex *in; 
    in = (kml_fft_complex*)kml_fft_malloc(sizeof(kml_fft_complex) * n0 * n1); 
    for (int i = 0; i < n0 * n1; i++) { 
        in[i][0] = init[i][0]; 
        in[i][1] = init[i][1]; 
    } 
    kml_fft_complex *out; 
    out = (kml_fft_complex*)kml_fft_malloc(sizeof(kml_fft_complex) * n0 * n1); 
    kml_fft_plan plan; 
    plan = kml_fft_plan_dft_2d(n0, n1, in, out, KML_FFT_FORWARD, KML_FFT_ESTIMATE); 
    kml_fft_execute_dft(plan, in, out); 
 
    kml_fft_destroy_plan(plan); 
    kml_fft_free(in); 
    kml_fft_free(out); 
 
    /* 
     * out = {{1.200000e+02, 4.800000e+01}, {1.338564e+02, -1.385641e+01}, 
     *        {1.061436e+02, 1.385641e+01}, {1.360000e+02, -3.200000e+01}, 
     *        {1.120000e+02, -8.000000e+00}, {1.120000e+02, -8.000000e+00}} 
     */
Fortran interface:
    INTEGER(C_INT) :: N0 = 2 
    INTEGER(C_INT) :: N1 = 3 
    REAL(C_DOUBLE), DIMENSION(6, 2) :: INIT 
    TYPE(KML_FFT_COMPLEX), POINTER :: IN, OUT 
    TYPE(C_PTR) :: PIN, POUT 
    TYPE(C_SIZE_T) :: SIZE 
    SIZE = 16 * N0 * N1 
    PIN = KML_FFT_MALLOC(SIZE) 
    POUT = KML_FFT_MALLOC(SIZE) 
    CALL C_F_POINTER(PIN, IN, SHAPE=[N0 * N1]) 
    CALL C_F_POINTER(POUT, OUT, SHAPE=[N0 * N1]) 
    DATA INIT/120, 8, 0, 0, 0, -8, 0, 8, 0, 16, 16, 8/ 
    INTEGER :: I 
    DO WHILE(I <= N(0) * N(1))  
        IN%R = INIT(I, 0) 
        IN%I = INIT(I, 1) 
    END DO 
     
    TYPE(C_PTR) :: PLAN 
    PLAN = KML_FFT_PLAN_DFT_2D(N0, N1, IN, OUT, KML_FFT_FORWARD, KML_FFT_ESTIMATE) 
    CALL KML_FFT_EXECUTE_DFT(PLAN, IN, OUT) 
 
    CALL KML_FFT_DESTROY_PLAN(PLAN) 
    CALL KML_FFT_FREE(PIN) 
    CALL KML_FFT_FREE(POUT) 
 
    ! 
    ! OUT = /1.200000E+02, 4.800000E+01, 1.338564E+02, -1.385641E+01, 
    !        1.061436E+02, 1.385641E+01, 1.360000E+02, -3.200000E+01, 
    !        1.120000E+02, -8.000000E+00, 1.120000E+02, -8.000000E+00/ 
    !