Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

fftw-wisdom-to-conf(1) [centos man page]

FFTW-WISDOM-TO-CONF(1)						       fftw						    FFTW-WISDOM-TO-CONF(1)

NAME
fftw-wisdom-to-conf - generate FFTW wisdom (pre-planned transforms) SYNOPSIS
fftw-wisdom-to-conf [< INPUT] [> OUTPUT] DESCRIPTION
fftw-wisdom-to-conf is a utility to generate C configuration routines from FFTW wisdom files, where the latter contain saved information about how to optimally compute (Fourier) transforms of various sizes. A configuration routine is a C subroutine that you link into your program, replacing a routine of the same name in the FFTW library, that determines which parts of FFTW are callable by your program. The reason to do this is that, if you only need transforms of a limited set of sizes and types, and if you are statically linking your pro- gram, then using a configuration file generated from wisdom for those types can substantially reduce the size of your executable. (Other- wise, because of FFTW's dynamic nature, all of FFTW's transform code must be linked into any program using FFTW.) FFTW is a free library to compute discrete Fourier transforms in one or more dimensions, for arbitrary sizes, and of both real and complex data, among other related operations. More information on FFTW can be found at the FFTW home page: http://www.fftw.org fftw-wisdom-to-conf reads wisdom from standard input and writes the configuration to standard output. It can easily be combined with the fftw-wisdom tool, for example: fftw-wisdom -n cof1024 cob1024 -o wisdom fftw-wisdom-to-conf < wisdom > conf.c will create a configuration "conf.c" containing only those parts of FFTW needed for the optimized complex forwards and backwards out-of- place transforms of size 1024 (also saving the wisdom itself in "wisdom"). Alternatively, you can run your actual program, export wisdom for all plans that were created (ideally in FFTW_PATIENT or FFTW_EXHAUSTIVE mode), use this as input for fftw-wisdom-to-conf, and then re-link your program with the resulting configuration routine. Note that the configuration routine does not contain the wisdom, only the routines necessary to implement the wisdom, so your program should also import the wisdom in order to benefit from the pre-optimized plans. OPTIONS
-h, --help Display help on the command-line options and usage. -V, --version Print the version number and copyright information. BUGS
Send bug reports to fftw@fftw.org. AUTHORS
Written by Steven G. Johnson and Matteo Frigo. Copyright (c) 2003, 2007-11 Matteo Frigo Copyright (c) 2003, 2007-11 Massachusetts Institute of Technology SEE ALSO
fftw-wisdom(1) fftw February, 2003 FFTW-WISDOM-TO-CONF(1)

Check Out this Related Man Page

mlib_SignalFFTW_4(3MLIB)				    mediaLib Library Functions					  mlib_SignalFFTW_4(3MLIB)

NAME
mlib_SignalFFTW_4, mlib_SignalFFTW_4_S16_S16, mlib_SignalFFTW_4_S16C_S16C, mlib_SignalFFTW_4_S16C_S16, mlib_SignalFFTW_4_S16, mlib_Sig- nalFFTW_4_S16C - signal Fast Fourier Transform with windowing (FFTW) SYNOPSIS
cc [ flag... ] file... -lmlib [ library... ] #include <mlib.h> mlib_status mlib_SignalFFTW_4_S16_S16(mlib_s16 *dstr, mlib_s16 *dsti, const mlib_s16 *srcr, const mlib_s16 *srci, const mlib_s16 *window, mlib_s32 order, mlib_s32 *scale); mlib_status mlib_SignalFFTW_4_S16C_S16C(mlib_s16 *dstc, const mlib_s16 *srcc,const mlib_s16 *window, mlib_s32 order, mlib_s32 *scale); mlib_status mlib_SignalFFTW_4_S16C_S16(mlib_s16 *dstc, const mlib_s16 *srcr,const mlib_s16 *window, mlib_s32 order, mlib_s32 *scale); mlib_status mlib_SignalFFTW_4_S16(mlib_s16 *srcdstr, mlib_s16 *srcdsti,const mlib_s16 *window, mlib_s32 order, mlib_s32 *scale); mlib_status mlib_SignalFFTW_4_S16C(mlib_s16 *srcdstc, const mlib_s16 *window,mlib_s32 order, mlib_s32 *scale); DESCRIPTION
Each of the functions in this group performs Fast Fourier Transform with windowing (FFTW). The FFTW functions use the following equation: 1 N-1 dst[k] = ---- SUM {src[n] * window[n] * exp(-j2*PI*n*k/N)} C1 n=0 and the IFFTW functions use the following equation: 1 N-1 dst[n] = ---- SUM {src[k] * window[k] * exp(j2*PI*n*k/N)} C2 k=0 where k = 0, 1, ..., (N - 1) n = 0, 1, ..., (N - 1) N = 2**order The signal FFTW/IFFTW functions can be categorized into four groups according to the ScaleMode in the function names in the following form: mlib_Signal[FFTW|IFFTW]_ScaleMode_OutType_InType_OpMode() mlib_Signal[FFTW|IFFTW]_ScaleMode_DataType_OpMode() The scaling factors C1 and C2 used in the equations are defined as follows: o For ScaleMode = 1, C1 = 1 and C2 = 2**order. o For ScaleMode = 2, C1 = 2**order and C2 = 1. o For ScaleMode = 3, C1 = C2 = 2**(order/2) when order is even, or C1 = 2**((order+1)/2) and C2 = 2**((order-1)/2) when order is odd. o For ScaleMode = 4, C1 = 2**P and C2 = 2**Q, where P and Q are adaptive scaling factors and are generated by the functions. For functions with only real parts for the source signal, the imaginary parts are assumed to be all zero. For functions with only real parts for the destination signal, the imaginary parts are discarded. The functions with only one data type in their names perform the oper- ation in place. PARAMETERS
Each function takes some of the following arguments: dstr Destination signal array that contains the real parts. dsti Destination signal array that contains the imaginary parts. srcr Source signal array that contains the real parts. srci Source signal array that contains the imaginary parts. dstc Complex destination signal array. dstc[2*i] contains the real parts, and dstc[2*i+1] contains the imaginary parts. srcc Complex source signal array. srcc[2*i] contains the real parts, and srcc[2*i+1] contains the imaginary parts. srcdstr Source and destination signal array that contains the real parts. srcdsti Source and destination signal array that contains the imaginary parts. srcdstc Complex source and destination signal array. srcdstc[2*i] contains the real parts, and srcdstc[2*i+1] contains the imaginary parts. window Window coefficient array with 2**order real elements. The window coefficients are in Q15 format for the S16 data type, or in float format for the F32 data type. order Order of the transformation. The base-2 logarithm of the number of data samples. scale Adaptive scaling factor. RETURN VALUES
Each function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
mlib_SignalFFTW_1(3MLIB), mlib_SignalFFTW_2(3MLIB), mlib_SignalFFTW_3(3MLIB), mlib_SignalIFFTW_1(3MLIB), mlib_SignalIFFTW_2(3MLIB), mlib_SignalIFFTW_3(3MLIB), mlib_SignalIFFTW_4(3MLIB), attributes(5) SunOS 5.11 2 Mar 2007 mlib_SignalFFTW_4(3MLIB)
Man Page