pygwb.notch.StochNotch

class pygwb.notch.StochNotch(minimum_frequency, maximum_frequency, description)

Bases: Notch

__init__(minimum_frequency, maximum_frequency, description)

A notch object storing the maximum and minimum frequency of the notch, as well as a description.

Parameters:

• minimum_frequency (float) – The minimum frequency of the notch (in Hz).

• maximum_frequency (float) – The maximum frequency of the notch (in Hz).

• description (str) – A description of the origin/reason of the notch.

See also

bilby.gw.detector.strain_data.Notch

More information here.

__call__(*args, **kwargs)

Call self as a function.

Methods

__init__(minimum_frequency, ...)	A notch object storing the maximum and minimum frequency of the notch, as well as a description.
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
get_notch_mask(frequency_array)	Get a boolean mask for the frequencies in frequency_array in the notch.
print_notch()	Small function that prints out the defining contents of 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

get_notch_mask(frequency_array)

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

Parameters:

frequency_array (np.ndarray) – An array of frequencies (in Hz).

Returns:

notch_mask: np.ndarray

An array of booleans that are False for frequencies in the notch.

Notes

This notches any frequency that may have overlapping frequency content with the notch.

print_notch()

Small function that prints out the defining contents of the notch. It will display the minimum and maximum frequency and the description of the notch.