FourierTransform.init_fftw_plan

FourierTransform.init_fftw_plan(planning_effort='measure', **kwargs)

Initialize the FFTW plan for this transform for later use.

If the implementation of this operator is not 'pyfftw', this method should not be called.

Parameters:
planning_effortstr, optional

Flag for the amount of effort put into finding an optimal FFTW plan. See the FFTW doc on planner flags. Options: {'estimate', 'measure', 'patient', 'exhaustive'}

planning_timelimitfloat or None, optional

Limit planning time to roughly this many seconds. Default: None (no limit)

threadsint, optional

Number of threads to use. Default: 1

Raises:
ValueError

If impl is not 'pyfftw'

See also

clear_fftw_plan

Notes

To save memory, clear the plan when the transform is no longer used (the plan stores 2 arrays).