Add an estimator for end frequency of the any custom waveform model #4911
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ahnitz
reviewed
Oct 16, 2024
pycbc/waveform/plugin.py
Outdated
| """ | ||
| from pycbc.waveform.waveform import _filter_ends | ||
| if approximant in _filter_ends: | ||
| raise RuntimeError("Can't load length estimator {}, the name is" |
There was a problem hiding this comment.
The message here should be updated.
|
@Kanchan-05 You need to rebase this PR from master (don't do a merge commit) |
Kanchan-05
force-pushed
the
end_frequency_estimator
branch
from
9997119
to
8093e6e
Compare
|
@Kanchan-05 You seem to be committing a bunch of files unrelated to your PR. Also, you need to rebase from gwastro's master, not your local one if that's what you did. |
Kanchan-05
force-pushed
the
end_frequency_estimator
branch
from
8093e6e
to
f5ad2c3
Compare
|
@Kanchan-05 Address the codeclimate issues, otherwise, this looks reasonable. |
ahnitz
approved these changes
Oct 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Standard information about the request
This is a new feature added for estimating the end frequency of any custom waveform model
This feature will affect plugin.py for waveform
This change affects: the offline search, the live search, inference, PyGRB
This change changes: documentation, scientific output
This change: has appropriate unit tests, follows style guidelines (See e.g. PEP8), has been proposed using the contribution guidelines
This change will: break current functionality, require a new release
Motivation
Custom waveform approximants may or may not have a frequency-domain version. To make any time-domain waveform useful for searches or parameter estimation, get_fd_waveform_from_td is used. For an accurate time-to-frequency domain transformation, the sampling rate must be appropriately adjusted. This adjustment depends on both the duration of the signal in the time domain and the end frequency of the waveform. The signal duration and end frequency can vary depending on the source parameters and waveform approximants.
While PyCBC already includes a function to estimate the signal duration, it does not yet have a way to estimate the end frequency. That is why adding an end frequency estimator is important.
Contents
Links to any issues or associated PRs
Testing performed
Additional notes