Gaussian
class Gaussian(duration, amp, sigma, name=None)
A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2):
Initialize the gaussian pulse.
Parameters
- duration (
int) – Pulse length in terms of the the sampling period dt. - amp (
complex) – The amplitude of the Gaussian envelope. - sigma (
float) – 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
amp
Type: complex
The Gaussian amplitude.
Return type
complex
id
Type: int
Unique identifier for this pulse.
Return type
int
parameters
Type: Dict[str, Any]
Return a dictionary containing the pulse’s parameters.
Return type
Dict[str, Any]
sigma
Type: float
The Gaussian standard deviation of the pulse width.
Return type
float
Methods
__call__
Gaussian.__call__(channel)
Call self as a function.
draw
Gaussian.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, interactive=False, scaling=None)
Plot the pulse.
Parameters
- dt (
float) – Time interval of samples. - style (Optional[PulseStyle]) – A style sheet to configure plot appearance
- filename (
Optional[str]) – Name required to save pulse image - interp_method (
Optional[Callable]) – A function for interpolation - scale (
float) – Relative visual scaling of waveform amplitudes - interactive (
bool) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) - scaling (
Optional[float]) – Deprecated, see scale
Returns
A matplotlib figure object of the pulse envelope
Return type
matplotlib.figure
get_sample_pulse
Gaussian.get_sample_pulse()
Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains.
Return type
validate_parameters
Gaussian.validate_parameters()
Validate parameters.
Raises
PulseError – If the parameters passed are not valid.
Return type
None