bilby.gw.detector.strain_data.Notch

class bilby.gw.detector.strain_data.Notch(minimum_frequency, maximum_frequency)

Bases: object

__init__(minimum_frequency, maximum_frequency)

A notch object storing the maximum and minimum frequency of the notch

Parameters:

minimum_frequency, maximum_frequency: float

The minimum and maximum frequency of the notch

__call__(*args, **kwargs)

Call self as a function.

Methods

__init__(minimum_frequency, maximum_frequency)	A notch object storing the maximum and minimum frequency of the notch
check_frequency(freq)	Check if freq is inside the notch
get_idxs(frequency_array)	Get a boolean mask for the frequencies in frequency_array in the notch

check_frequency(freq)

Check if freq is inside the notch

Parameters:

freq: float

The frequency to check

Returns:

True/False:

If freq inside the notch, return True, else False

get_idxs(frequency_array)

Get a boolean mask for the frequencies in frequency_array in the notch

Parameters:

frequency_array: np.ndarray

An array of frequencies

Returns:

idxs: np.ndarray

An array of booleans which are True for frequencies in the notch