Code Documentation

This page shows the documentation generated by sphinx automatically scanning our source code

sine_wave_utilities

MyPackage.sine_wave_utilities.data_plotter(x, y, x_label='x', y_label='y', title='excellent graph', grid=True)

just plots the data in x and y as a line plot

Parameters:

• x (1D list or array) – x data for plotting;

• y (1D list or array) – y data for plotting

• x_label (str, optional) – x axis label

• y_label (str, optional) – y axis label

• title (str, optional) – plot title

• grid (bool, optional) – True plots grid

MyPackage.sine_wave_utilities.generate_sine_data(Amplitude=1, Phase=0, Frequency=1, x_min=0, x_max=6.283185307179586, n_samples=2000)

generates sine data for the fiven input parameters

Parameters:

• Amplitude (float) – amplitude of sine wave

• Phase (float) – phase of sine wave

• Frequency (float) – frequency of sine wave

• x_min (float) – minimum x data

• x_max (float) – maximum x data

• n_samples (int) – number of samples in x

Returns:

x, y, the x and y values of the generated sine plot