BGlib.gmode.proc.fft.NoiseBandFilter

class BGlib.gmode.proc.fft.NoiseBandFilter(signal_length, samp_rate, freqs, freq_widths, show_plots=False)[source]

Bases: FrequencyFilter

Builds a filter that removes specified noise frequencies

Parameters:

  • signal_length (unsigned int) – Number of points in the FFT signal

  • samp_rate (unsigned int) – sampling rate in Hz

  • freqs (1D array or list) – Target frequencies as unsigned ints

  • freq_widths (1D array or list) – Width around the target frequency that should be set to 0

  • show_plots (bool) – If True, plots will be displayed during calculation. Default False

Note

sampRate, freqs, freq_widths have same units - eg MHz

Returns:

noise_filter – Array of ones set to 0 at noise bands

Return type:

1D numpy array

Methods

get_parms

is_compatible