scipy.ndimage.fourier_ellipsoid

scipy.ndimage.fourier_ellipsoid(input, size, n=-1, axis=-1, output=None)

Multi-dimensional ellipsoid fourier filter.

The array is multiplied with the fourier transform of a ellipsoid of given sizes.

Parameters:

input : array_like

The input array.

size : float or sequence

The size of the box used for filtering. If a float, size is the same for all axes. If a sequence, size has to contain one value for each axis.

n : int, optional

If n is negative (default), then the input is assumed to be the result of a complex fft. If n is larger than or equal to zero, the input is assumed to be the result of a real fft, and n gives the length of the array before transformation along the real transform direction.

axis : int, optional

The axis of the real transform.

output : ndarray, optional

If given, the result of filtering the input is placed in this array. None is returned in this case.

Returns:

fourier_ellipsoid : ndarray or None

The filtered input. If output is given as a parameter, None is returned.

Notes

This function is implemented for arrays of rank 1, 2, or 3.