make_fourier_correlation
- hcipy.fourier.make_fourier_correlation(input_grid, kernel, q=1)[source]
Create a
FourierFilterthat performs correlation with a spatial kernel.- Parameters:
- input_gridGrid
The grid that is expected for the input field.
- kernelField or callable
The spatial correlation kernel. If a callable, it is evaluated on the internal padded spatial grid and must return a
Field. If aField, its grid’sdeltamust equalinput_grid.delta.- qscalar
The amount of zeropadding to perform in the real domain. A value of 1 means no zeropadding.
- Returns:
- FourierFilter
An operator that performs the correlation.
- Raises:
- ValueError
When a Field is given as the kernel, and its pixel size is not the same as the pixel size of the input grid.