bilby.gw.utils.matched_filter_snr

bilby.gw.utils.matched_filter_snr(signal, frequency_domain_strain, power_spectral_density, duration)[source]

Calculate the _complex_ matched filter snr of a signal. This is <signal|frequency_domain_strain> / optimal_snr

Parameters:
signal: array_like

Array containing the signal

frequency_domain_strain: array_like
power_spectral_density: array_like
duration: float

Time duration of the signal

Returns:
float: The matched filter signal to noise ratio squared