make_fourier_transform

hcipy.fourier.make_fourier_transform(input_grid, output_grid=None, q=1, fov=1, shift=0, planner='estimate')

Construct a FourierTransform object.

The most time-efficient Fourier transform method will be chosen according to actual or estimated performance.

Parameters:
input_gridGrid

The grid that will be used for the Field passed to the Fourier transform.

output_gridNone or Grid

The grid of the resulting field. If it is None, a optimal grid will be chosen, according to q and fov.

qscalar or ndarray

Describes how many samples to take in the Fourier domain. A value of 1 means critcally sampled in the Fourier domain.

fovscalar or ndarray

Describes how far out the Fourier domain extends. A value of 1 means the same amount of samples as the spatial domain.

shiftscalar or ndarray

Describes by how much the Fourier domain should be shifted compared to the native sampling of FFT.

plannerstring

If it is ‘estimate’, performance of the different methods will be estimated from theoretical complexity estimates. If it is ‘measure’, actual Fourier transforms will be performed to get the actual performance. The latter takes longer, but is more accurate.

Returns:
FourierTransform

The Fourier transform that was requested.