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

Wrappers for working with fftw plans. More...

Wrappers for working with fftw plans.

Functions

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

Function Documentation

◆ fftw_cleanup()

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

Cleanup persistent planner data.

References fftw_cleanup().

Referenced by mx::math::ft::fftwEnvironment< realT, threads >::~fftwEnvironment(), and fftw_cleanup().

◆ fftw_cleanup_threads()

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

Cleanup persistent planner data and threads data.

References fftw_cleanup_threads().

Referenced by fftw_cleanup_threads().

◆ fftw_make_planner_thread_safe()

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

Wrapper for fftwX_make_planner_thread_safe().

Template Parameters
realTthe real floating point type

References fftw_make_planner_thread_safe().

Referenced by fftw_make_planner_thread_safe().

◆ fftw_plan_dft()

template<typename inputDataT, typename outputDataT>
fftwTypeSpec< inputDataT, outputDataT >::planT mx::math::ft::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

References fftw_plan_dft().

Referenced by fftw_plan_dft().

◆ fftw_plan_with_nthreads()

template<typename realT>
void mx::math::ft::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.

References fftw_plan_with_nthreads().

Referenced by fftw_plan_with_nthreads().