frequency_content

typhoon.test.harmonic.frequency_content(signal, max_frequency, during=None)

Calculates the list of harmonic components for a signal using FFT.

Parameters:

  • signal (Series) – A Pandas Series with the signal the harmonic components are to be calculated.

  • max_frequency (int) – Maximum frequency to be taken into consideration in the results.

  • during (2-element tuple of float/int or Timedelta) – Period of signal to consider for the calculation.

Returns:

result – Result of the frequency analysis.

Return type:

FFTResult

Examples

>>> import typhoon.test.signals as signals
>>> import typhoon.test.harmonic as harmonic

>>> serie = signals.pandas_sine(amplitude=100, frequency=60) # zeroed signal
>>> serie += signals.pandas_sine(amplitude=10, frequency=120)
>>> serie += signals.pandas_sine(amplitude=2, frequency=180)
>>> content = harmonic.frequency_content(serie, 200)

>>> plot(content.freqs, content.fft)
>>> content(60)
>>> content(10)
>>> content(2)