Skip to content

Commit c244c9d

Browse files
Update bilby/gw/detector/interferometer.py
Co-authored-by: Colm Talbot <talbotcolm@gmail.com>
1 parent fa633fd commit c244c9d

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

bilby/gw/detector/interferometer.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,9 @@ def inner_product(self, signal):
603603
604604
Returns
605605
=======
606-
float: The optimal signal to noise ratio possible squared
606+
float:
607+
The noise-weighted inner product between the passed signal
608+
and the data stored in the :code:`Interferometer`.
607609
"""
608610
whitened_signal = self.whiten_frequency_series(signal)
609611
whitened_data = self.whitened_frequency_domain_strain

0 commit comments

Comments
 (0)