Gaussian

class Gaussian(duration, amp, sigma, name=None)[source]

A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2):

\[f(x) = amp * exp( -(1/2) * (x - duration/2)^2 / sigma^2) ) , 0 <= x < duration\]

Initialize the gaussian pulse.

Parameters
  • duration (int) – Pulse length in terms of the the sampling period dt.

  • amp (Union[complex, ParameterExpression]) – The amplitude of the Gaussian envelope.

  • sigma (Union[float, ParameterExpression]) – A measure of how wide or narrow the Gaussian peak is; described mathematically in the class docstring.

  • name (Optional[str]) – Display name for this pulse envelope.

Attributes

Gaussian.amp

The Gaussian amplitude.

Gaussian.id

Unique identifier for this pulse.

Gaussian.parameters

Return a dictionary containing the pulse’s parameters.

Gaussian.sigma

The Gaussian standard deviation of the pulse width.

Methods

Gaussian.assign_parameters(value_dict)

Return a new ParametricPulse with parameters assigned.

Gaussian.draw([dt, style, filename, …])

Plot the pulse.

Gaussian.get_sample_pulse()

Deprecated.

Gaussian.get_waveform()

Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains.

Gaussian.validate_parameters()

Validate parameters.