Improve private parse_harmonic function #138
Merged
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.
Description
This PR proposes the following changes to the private
_utils.parse_harmonic
function:samples
withharmonic_max
parameter to make the function more consistent and easier to understand.harmonic_max
parameter optional to allow for cases where the upper harmonics limit is unknown (as in Simplify multiple harmonic calibration #124).This simplifies existing code a little.
Also added a note to the
phasor_from_signal
function that "A minimum ofharmonic * 2 + 1
samples are required alongaxis
to calculate correct phasor coordinates atharmonic
". This is actually not verified inparse_harmonic
and Fourier transform does return second harmonic numbers for 4 samples even though they are not correct phasor coordinates (as far as I understand). There is however a verified requirement for an absolute minimum of three signal samples.Checklist