pandas_sine¶
- typhoon.test.signals.pandas_sine(amplitude=1, frequency=60, duration=1, phase=0, Ts=0.0001)¶
Generates a pandas Series with a sine wave with given characteristics.
- Parameters:
amplitude (float) – Sine amplitude
frequency (float) – Sine frequency, in Hz
duration (float) – Time duration of the whole signal, in seconds
phase (float) – Phase of the sine wave
Ts (float) – Sampling rate of the sine wave.
- Returns:
Timeseries signal of the sine wave.
- Return type:
Series
Notes
This function can typically be used to easily get a pandas Series for learning and quick testing purposes.
Examples
>>> from typhoon.test.signals import pandas_sine >>> sine = pandas_sine() # with default parameters >>> print(sine)
See also