FFTResult

class typhoon.test.harmonic.FFTResult(signal, fft, freqs)

Bases: object

Result of frequency_content analysis.

Examples

>>> from typhoon.test.harmonic import frequency_content
>>> content = frequency_content(signal, 2000)  # content is an FFTResult
>>> content(60)  # Acts as a function with frequency in Hertz as argument

Getting attributes from the result:

>>> print(content.signal)  # prints time signal from which frequency analysis was made
>>> from matplotlib import pyplot as plt
>>> magnitudes = abs(content.fft)  # content.fft contains the complex numbers array
>>> plt.plot(content.freqs, magnitudes)   # content.freqs contains the frequencies array

Attributes Summary

fft

Complex numbers array corresponding to each frequency.

freqs

Frequencies array.

signal

Original signal from which analysis was made.

Methods Summary

__call__(freq[, tol])

When calling the FFTResult object as a function.

Attributes Documentation

fft

Complex numbers array corresponding to each frequency.

freqs

Frequencies array.

signal

Original signal from which analysis was made.

Methods Documentation

__call__(freq, tol=0.01)

When calling the FFTResult object as a function.

Parameters:
  • freq (float) – Frequency from which the FFT result is desired.

  • tol (float) – If desired frequency does not exist exactly in the results, it will be returned the closest frequency inside this tolerance (absolute).