lib/
gpufft.pro
Routines
result = gpufft(p1 [, direction] [, LHS=GPUVariable object] [, PLAN=long] [, /INVERSE] [, /DIM2D] [, /DENORMALIZED] [, /DESTROYPLAN] [, /BATCH] [, ERROR=int])Perform FFT on the GPU
result = gpufft_undef()The procedure form of GPUFFT needs to be able to match the ARG_PRESENT and N_ELEMENTS values of its inputs when it sends them to the function form of GPUFFT.
gpufft, p1, res_gpu [, direction] [, PLAN=long] [, /INVERSE] [, /DIM2D] [, /DENORMALIZED] [, /DESTROYPLAN] [, /BATCH] [, ERROR=int]Perform FFT on the GPU
Routine details
top gpufft
result = gpufft(p1 [, direction] [, LHS=GPUVariable object] [, PLAN=long] [, /INVERSE] [, /DIM2D] [, /DENORMALIZED] [, /DESTROYPLAN] [, /BATCH] [, ERROR=int])
Perform FFT on the GPU
The FFT can operate either on real or complex signals, and perform both 1D and 2D transforms. Complex number arrays use an interleaved memory layout and are otherwise treated as regular real arrays. Use the gpuReal and gpuImaginary routines to extract the real and imaginary component.
Return value
GPUVariable object structure
Parameters
- p1 in required type=GPUVariable object
GPU array to perform FFT on
- direction in optional type=integer
-1 to perform FFT, 1 to peform inverse FFT
Keywords
- LHS in optional type=GPUVariable object
pass GPU variable to use as return value
- PLAN in out optional type=long
The plan to be used for this transform. If undefined upon entry, a new plan will be created and returned in this variable.
- INVERSE in optional type=boolean
Perform an inverse complex to complex FFT. Only valid in combination with the COMPLEX2COMPLEX keyword.
- DIM2D in optional obsolete type=boolean
Perform a 2D FFT on the input data set. The dimensionality is extracted from the input object.
- DENORMALIZED in optional type=boolean
Perform a denormalized transform. By default, the result is normalized by the number of input vector elements. This option allows to skip this normalization step, yielding slightly faster exectution.
- DESTROYPLAN in optional type=boolean
Frees the GPU resoures occupied by the FFT plan. This invalidates the plan and requires a new plan to be generated.
- BATCH in optional type=boolean
Set to run 1D FFTs on a 2D array where each 1D FFT is along a row of the 2D array.
- ERROR out optional type=int
Error code.
Other attributes
- Todo:
BATCH does not work in pure IDL emulation
top gpufft_undef
result = gpufft_undef()
The procedure form of GPUFFT needs to be able to match the ARG_PRESENT and N_ELEMENTS values of its inputs when it sends them to the function form of GPUFFT.
The following table lists how to pass along a variable given the different
cases of its ARG_PRESENT and N_ELEMENTS status:
====================== =========================
ARG_PRESENT(arg)
-------------------------
0 1
---------------------- -------------- ----------
N_ELEMENTS(arg) eq 0 gpufft_undef() arg
N_ELEMENTS(arg) gt 0 temporary(arg) arg
====================== =========================
Return value
undefined expression
top gpufft
gpufft, p1, res_gpu [, direction] [, PLAN=long] [, /INVERSE] [, /DIM2D] [, /DENORMALIZED] [, /DESTROYPLAN] [, /BATCH] [, ERROR=int]
Perform FFT on the GPU
The FFT can operate either on real or complex signals, and perform both 1D and 2D transforms. Complex number arrays use an interleaved memory layout and are otherwise treated as regular real arrays. Use the gpuReal and gpuImaginary routines to extract the real and imaginary component.
Parameters
- p1 in required type=GPUVariable object
GPU array to perform FFT on
- res_gpu out required type=GPUVariable object
GPU array containing the result
- direction in optional type=integer
-1 to perform FFT, 1 to peform inverse FFT
Keywords
- PLAN in out optional type=long
The plan to be used for this transform. If undefined upon entry, a new plan will be created and returned in this variable.
- INVERSE in optional type=boolean
Perform an inverse complex to complex fft. Only valid in combination with the COMPLEX2COMPLEX keyword.
- DIM2D in optional obsolete type=boolean
Perform a 2D fft on the input data set. The dimensionality is extracted from the input object.
- DENORMALIZED in optional type=boolean
Perform a denormalized transform. By default, the result is normalized by the number of input vector elements. This option allows to skip this normalization step, yielding slightly faster exectution.
- DESTROYPLAN in optional type=boolean
Frees the GPU resoures occupied by the fft plan. This invalidates the plan and requires a new plan to be generated.
- BATCH in optional type=boolean
Set to run 1D FFTs on a 2D array where each 1D FFT is along a row of the 2D array.
- ERROR out optional type=int
Error code.
File attributes
| Modification date: | Fri Nov 12 11:07:43 2010 |
| Lines: | 272 |
| Docformat: | rst rst |