kml_ffth_plan_dft_scale_2d

Create a plan for the two-dimensional C2C transform of a single contiguous data array.

Interface Definition

C interface:

kml_ffth_plan kml_ffth_plan_dft_scale_2d(int n0, int n1, kml_ffth_complex *in, kml_ffth_float_complex *out, int sign, unsigned flags);

Return Value

The function returns a structure pointer of the kml_ffth_plan type. This object can be passed to the kml_fft(f/h)_execute function as a parameter to perform FFT on the current input and output. This object can also be passed to the kml_ffth_execute_dft_scale function as a parameter to perform FFT on new input and output.

If this function returns a non-null pointer, the plan has been successfully created. Otherwise, the plan fails to be created.

Parameters

Parameter	Data Type	Description	Input/Output
n0	int	Inputs the FFT array size. The constraint is n0 ≥ 1.	Input
n1	int	Inputs the FFT array size. The constraint is n1 ≥ 1.	Input
in	kml_ffth_complex*	Inputs the data to be transformed.	Input
out	kml_ffth_float_complex *	Outputs the data generated using FFT.	Output
sign	int	Specifies forward or backward transform. -1(KML_FFT_FORWARD): forward +1(KML_FFT_BACKWARD): backward	Input
flags	unsigned int	Planning option, which describes the ESTIMATE or PATIENT mode. KML_FFT_ESTIMATE: ESTIMATE mode KML_FFT_PATIENT: PATIENT mode	Input

Dependencies

C: "kfft.h"

Examples

C interface:

    int n0 = 2;
    int n1 = 3; 
    kml_ffth_complex *in; 
    kml_ffth_complex *out; 
    kml_ffth_plan plan; 
    in = (kml_ffth_complex*)kml_ffth_malloc(sizeof(kml_ffth_complex) * n0 * n1); 
    out = (kml_ffth_float_complex*)kml_ffth_malloc(sizeof(kml_ffth_float_complex) * n0 * n1); 
    for (int i = 0; i < n0 * n1; i++){ 
        in[i][0] = (__fp16)i; 
        in[i][1] = (__fp16)i; 
    } 
    plan = kml_ffth_plan_dft_scale_2d(n0 , n1, in , out, KML_FFT_FORWARD, KML_FFT_ESTIMATE); 
    kml_ffth_execute_dft_scale(plan, in, out); 
 
    kml_ffth_destroy_plan(plan); 
    kml_ffth_free(in); 
    kml_ffth_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}} 
     */

Parent topic: C2C Transforms