mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]

Wrappers for working with fftw plans. More...

Wrappers for working with fftw plans.

Functions

template<typename realT >
void mx::math::fft::fftw_make_planner_thread_safe ()
 Wrapper for fftwX_make_planner_thread_safe() More...
 
template<typename realT >
void mx::math::fft::fftw_plan_with_nthreads (int nthreads)
 Tell the FFTW planner how many threads to use. More...
 
template<typename inputDataT , typename outputDataT >
fftwTypeSpec< inputDataT, outputDataT >::planT mx::math::fft::fftw_plan_dft (std::vector< int > n, inputDataT *in, outputDataT *out, int sign, unsigned flags)
 Wrapper for the fftwX_plan_dft functions. More...
 
template<typename realT >
void mx::math::fft::fftw_cleanup ()
 Cleanup persistent planner data. More...
 
template<typename realT >
void mx::math::fft::fftw_cleanup_threads ()
 Cleanup persistent planner data and threads data. More...
 

Function Documentation

◆ fftw_cleanup()

template<typename realT >
void mx::math::fft::fftw_cleanup ( )

Cleanup persistent planner data.

◆ fftw_cleanup_threads()

template<typename realT >
void mx::math::fft::fftw_cleanup_threads ( )

Cleanup persistent planner data and threads data.

◆ fftw_make_planner_thread_safe()

template<typename realT >
void mx::math::fft::fftw_make_planner_thread_safe ( )

Wrapper for fftwX_make_planner_thread_safe()

Template Parameters
realTthe real floating point type

◆ fftw_plan_dft()

template<typename inputDataT , typename outputDataT >
fftwTypeSpec<inputDataT,outputDataT>::planT mx::math::fft::fftw_plan_dft ( std::vector< int >  n,
inputDataT *  in,
outputDataT *  out,
int  sign,
unsigned  flags 
)

Wrapper for the fftwX_plan_dft functions.

Parameters
nis a vector of ints containing the size of each dimension.
inis the input data array
outis the output data array
signspecifies forward or backwards, i.e. FFTW_FORWARD or FFTW_BACKWARD.
flagsother fftw flags
Returns
an fftw plan for the types specified.
Template Parameters
inputDataTthe data type of the input array
outputDataTthe data type of the output array

◆ fftw_plan_with_nthreads()

template<typename realT >
void mx::math::fft::fftw_plan_with_nthreads ( int  nthreads)

Tell the FFTW planner how many threads to use.

Template Parameters
realTthe real floating point type.
Parameters
[in]nthreadsthe number of threads. Set to 1 to disable threads.