Skip to content

docs: fix matched filter SNR docstrings (closes #731) #1069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
christianescamilla15-cell wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −2
Open

docs: fix matched filter SNR docstrings (closes #731) #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ The original MRs are only visible on the [LIGO GitLab repository](https://git.li

## [Unreleased]

### Fixes
* Corrected incorrect docstrings for `matched_filter_snr` and `optimal_snr_squared` in `bilby/gw/utils.py` (closes #731)

## [2.7.1]

### Fixes
Expand Down
4 changes: 2 additions & 2 deletions bilby/gw/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ def matched_filter_snr(signal, frequency_domain_strain, power_spectral_density,

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

"""
rho_mf = noise_weighted_inner_product(
Expand Down Expand Up @@ -184,7 +184,7 @@ def optimal_snr_squared(signal, power_spectral_density, duration):

Returns
=======
float: The matched filter signal to noise ratio squared
float: The square of the optimal matched filter signal to noise ratio

"""
return noise_weighted_inner_product(signal, signal, power_spectral_density, duration)
Expand Down