Signal library

The signal library module provides functions for creating common analytical signals. These functions are useful for creating signals to use with third party devices.

The functions in this module generate signals represented by a boulderopal.signals.Signal object. You can then sample and export them as a NumPy array using the export methods of the created object (export_with_sampling_rate or export_with_time_step).

If you want to use predefined analytical signals in graphs, see Predefined signals.

For a quick introduction, see the topic Libraries of signals for Boulder Opal.

Classes

Signal

A class that contains information about a signal that can be discretized.

Functions

cosine_pulse

Create a Signal object representing a cosine pulse.

gaussian_pulse

Create a Signal object representing a Gaussian pulse.

hann_series

Create a Signal object representing a sum of Hann window functions.

linear_ramp

Create a Signal object representing a linear ramp.

sech_pulse

Create a Signal object representing a hyperbolic secant pulse.

sinusoid

Create a Signal object representing a sinusoidal oscillation.

square_pulse

Create a Signal object representing a square pulse.

tanh_ramp

Create a Signal object representing a hyperbolic tangent ramp.