navigate.model.waveforms.sine_wave

navigate.model.waveforms.sine_wave(sample_rate=100000, sweep_time=0.4, frequency=10, amplitude=1, offset=0, phase=0)

Returns a numpy array with a sine waveform

Used for creating analog laser drive voltage.

Parameters:

• sample_rate (int, optional) – Unit - Hz, by default 100000

• sweep_time (float, optional) – Unit - Seconds, by default 0.4

• frequency (int, optional) – Unit - Hz, by default 10

• amplitude (float, optional) – Unit - Volts, by default 1

• offset (float, optional) – Unit - Volts, by default 0

• phase (float, optional) – Unit - Radians, by default 0

Returns:

waveform

Return type:

np.array

Examples

>>> typical_laser = sine_wave(sample_rate, sweep_time, 10, 1, 0, 0)