quil.waveform

View Source

 1# This file is automatically generated by pyo3_stub_gen
 2# ruff: noqa: F401
 3
 4from quil._quil.waveform import BoxcarKernel, BuiltinWaveform, CommonBuiltinParameters, DragGaussian, ErfSquare, ExplicitCommonBuiltinParameters, Flat, Gaussian, HermiteGaussian, RaisedCosine, Waveform, WaveformError, WaveformInvocationError, WaveformParameterError, apply_phase_and_detuning, sampling
 5__all__ = [
 6    "BoxcarKernel",
 7    "BuiltinWaveform",
 8    "CommonBuiltinParameters",
 9    "DragGaussian",
10    "ErfSquare",
11    "ExplicitCommonBuiltinParameters",
12    "Flat",
13    "Gaussian",
14    "HermiteGaussian",
15    "RaisedCosine",
16    "Waveform",
17    "WaveformError",
18    "WaveformInvocationError",
19    "WaveformParameterError",
20    "apply_phase_and_detuning",
21    "sampling",
22]

class BoxcarKernel:

A boxcar waveform.

This waveform is a Rigetti extension to Quil-T.

def iq_values_at_sample_rate(self, /, common, sample_rate):

The type of the None singleton.

class BuiltinWaveform:

def iq_values_at_sample_rate(self, /, common, sample_rate):

The type of the None singleton.

def as_inner(self, /):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

class CommonBuiltinParameters:

def resolve_with_sample_rate(self, /, sample_rate):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

duration

scale

phase

detuning

class DragGaussian:

def iq_values_at_sample_rate(self, /, common, sample_rate):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

alpha

fwhm

anh

class ErfSquare:

def iq_values_at_sample_rate(self, /, common, sample_rate):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

pad_left

risetime

pad_right

class ExplicitCommonBuiltinParameters:

Like [CommonBuiltinParameters<Concrete>], but with the defaults resolved and the duration discretized.

This does not take a [WaveformData] parameter because it only makes sense for [Concrete] waveforms.

phase

Phase shift for the entire waveform.

detuning

Explicit detuning to bake into IQ values.

sample_count

Integral number of samples that should be taken of the pulse

Corresponds to [CommonBuiltinParameters::duration].

scale

Scale to apply to waveform envelope.

class Flat:

def iq_values_at_sample_rate(self, /, common, sample_rate):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

class Gaussian:

def iq_values_at_sample_rate(self, /, common, sample_rate):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

fwhm

class HermiteGaussian:

def iq_values_at_sample_rate(self, /, common, sample_rate):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

second_order_hrm_coeff

anh

fwhm

alpha

class RaisedCosine:

def iq_values_at_sample_rate(self, /, common, sample_rate):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

pad_left

pad_right

rolloff

class Waveform:

def drag_gaussian( *, duration, scale=None, phase=None, detuning=None, fwhm, t0, anh, alpha):

The type of the None singleton.

def gaussian(*, duration, scale=None, phase=None, detuning=None, fwhm, t0):

The type of the None singleton.

def hermite_gaussian( *, duration, scale=None, phase=None, detuning=None, fwhm, t0, anh, alpha, second_order_hrm_coeff):

The type of the None singleton.

def erf_square( *, duration, scale=None, phase=None, detuning=None, risetime, pad_left, pad_right):

The type of the None singleton.

def flat(*, duration, scale=None, phase=None, detuning=None, iq):

The type of the None singleton.

def boxcar_kernel(*, duration, scale=None, phase=None, detuning=None):

The type of the None singleton.

def raised_cosine( *, duration, scale=None, phase=None, detuning=None, rolloff, pad_left, pad_right):

The type of the None singleton.

def from_quil(invocation):

The type of the None singleton.

def builtin(waveform, common_parameters):

The type of the None singleton.

def custom(name, parameters):

The type of the None singleton.

def as_builtin(self, /):

The type of the None singleton.

def as_custom(self, /):

The type of the None singleton.

def evaluate(self, /, real, complex):

The type of the None singleton.

class WaveformError(quil._quil.QuilError):

Base error type for errors related to waveform processing.

Inherited Members

builtins.Exception: Exception
builtins.BaseException: with_traceback; add_note; args

class WaveformInvocationError(quil.waveform.WaveformError):

Errors that may occur when parsing a waveform.

Inherited Members

builtins.Exception: Exception
builtins.BaseException: with_traceback; add_note; args

class WaveformParameterError(quil.waveform.WaveformError):

Errors that may occur when parsing waveform parameters.

Inherited Members

builtins.Exception: Exception
builtins.BaseException: with_traceback; add_note; args

def apply_phase_and_detuning(iq_values, phase, detuning, sample_rate):

Modulate and phase shift waveform IQ data in place.