get_fft_parameters

hcipy.fourier.get_fft_parameters(fft_grid, input_grid)

Try to reconstruct the FFT parameters of a grid.

Note

Not every grid is an FFT grid. This function will raise a ValueError if this is the case. You can alternatively use is_fft_grid() to check if a grid is an FFT grid or not.

Note

The parameters that this function outputs might not correspond perfectly to the original FFT parameters you used. However, it guarantees that an FFT grid generated with these reconstructed parameters will create the same FFT grid as an FFT generated with the original parameters.

Parameters

fft_gridGrid

A grid that corresponds to a native FFT grid of input_grid.

input_gridGrid

The grid defining the sampling in the real domain.

Returns

qndarray

The amount of zeropadding detected in the real domain.

fovndarray

The amount of cropping detected in the Fourier domain.

shiftndarray

The amount of shifting detected in the Fourier domain.

Raises

ValueError

If fft_grid does not correspond to an FFT grid of input_grid.