Open
Conversation
Contributor
|
Thanks for the PR! Let's talk tomorrow about what the public interface of this functionality should look like. Spontaneously I'm thinking something along these lines: @dataclass
class SignalParameters:
period: sc.Variable
phase: sc.Variable
def estimate_signal_phase_and_period(signal: DataArray, method: Literal['fit] | Literal['fft'] = 'fit') -> SignalParameters:
'''Lets the user estimate the parameters they need to associate events to a period slice.'''
...
def associate_events_to_period_slice(events: DataArray, signal_parameters: SignalParameters, period_slices: int) -> DataArray:
'''Adds the period slice index, or the phase of the center of the period slice, as a coord on the event data.'''
...This is very much a suggestion, so don't feel this is the only possible option. Other than
what other functionality should there be in this module? Maybe some sort of helper for visualizing the quality of the signal fit? |
This file contains hidden or 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
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.
No description provided.