Preprocessor.bandpass_mask

Preprocessor.bandpass_mask(shape, lowpass, highpass, sampling_rate=None, gaussian_sigma=0.0, omit_negative_frequencies=True)

Compute an approximate Butterworth bundpass filter. The returned filter has it’s DC component at the origin.

Parameters:

shapetuple of ints

Shape of the returned bandpass filter.

lowpassfloat

The lower boundary of the frequency range to be preserved. Lower values will retain broader, more global features.

maximum_frequencyfloat

The upper boundary of the frequency range to be preserved. Higher values will emphasize finer details and potentially noise.

sampling_rateNDarray, optional

The sampling rate along each dimension.

gaussian_sigmafloat, optional

Sigma value for the gaussian smoothing to be applied to the filter.

omit_negative_frequenciesbool, optional

Whether the wedge mask should omit negative frequencies, i.e. be applicable to non hermitian-symmetric fourier transforms.

Returns:

NDArray

Bandpass filtered.