Add ability to set frame for returned waveform #41
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.
This adds a
frame
keyword option toPrecessingSurrogate.__call__
and corresponding argument toSurrogateEvaluator.__call__
. Theframe
argument allows the user to specify which frame to return the waveform in,inertial
,co-precessing
, orco-orbital
. The default isinertial
. I added this mostly because I want to be able to see what the underlying modes are doing in precessing signals, before they are twisted up.I've tested this with
NRSur7dq4
and it seems to work. Other classes besidesPrecessingSurrogate
may need to be modified before this can be merged. SinceSurrogateEvaluator.__call__
will now try to pass aframe
argument to_sur_dimless
, any class that could be called here will also need to be able to consume aframe
argument. I don't know what other classes that might be. (Aside: abstract base classes would be useful here.)