acquisition_library#

Standard acquisition protocols for use with the quantify_scheduler.

Module Contents#

Classes#

AcquisitionOperation

This class is used to help differentiate an acquisition operation from the regular

Trace

The Trace acquisition protocol measures a signal s(t).

WeightedIntegratedComplex

Weighted integration acquisition protocol on a

SSBIntegrationComplex

This class implements a SingleSideBand Integration acquisition protocol with

ThresholdedAcquisition

Create a new instance of ThresholdedAcquisition.

NumericalWeightedIntegrationComplex

Implements a WeightedIntegratedComplex class using parameterized waveforms and

TriggerCount

Trigger counting acquisition protocol returning an integer.

Functions#

_is_increasing_at_constant_rate(→ bool)

Checks whether the array is increasing at a constant rate.
class AcquisitionOperation(name: str)[source]#

Bases: quantify_scheduler.Operation

This class is used to help differentiate an acquisition operation from the regular operations. This enables us to use plot_acquisition_operations() to highlight acquisition pulses in the pulse diagrams.

class Trace(duration: float, port: str, clock: str, acq_channel: int = 0, acq_index: int = 0, bin_mode: Union[quantify_scheduler.enums.BinMode, str] = BinMode.AVERAGE, t0: float = 0)[source]#

Bases: AcquisitionOperation

The Trace acquisition protocol measures a signal s(t).

Creates a new instance of Trace. The Trace acquisition protocol measures a signal s(t).

Only processing performed is rescaling and adding units based on a calibrated scale. Values are returned as a raw trace (numpy array of float datatype). Length of this array depends on the sampling rate of the acquisition device.

Parameters:

  • port – The acquisition port.

  • clock – The clock used to demodulate the acquisition.

  • duration – The acquisition duration in seconds.

  • acq_channel – The data channel in which the acquisition is stored, is by default 0. Describes the “where” information of the measurement, which typically corresponds to a qubit idx.

  • acq_index – The data register in which the acquisition is stored, by default 0. Describes the “when” information of the measurement, used to label or tag individual measurements in a large circuit. Typically corresponds to the setpoints of a schedule (e.g., tau in a T1 experiment).

  • bin_mode – Describes what is done when data is written to a register that already contains a value. Options are “append” which appends the result to the list or “average” which stores the weighted average value of the new result and the old register value, by default BinMode.APPEND

  • t0 – The acquisition start time in seconds, by default 0

class WeightedIntegratedComplex(waveform_a: Dict[str, Any], waveform_b: Dict[str, Any], port: str, clock: str, duration: float, acq_channel: int = 0, acq_index: int = 0, bin_mode: Union[quantify_scheduler.enums.BinMode, str] = BinMode.APPEND, phase: float = 0, t0: float = 0)[source]#

Bases: AcquisitionOperation

Weighted integration acquisition protocol on a complex signal in a custom complex window.

Creates a new instance of WeightedIntegratedComplex. Weighted integration acquisition protocol on a complex signal in a custom complex window.

A weighted integrated acquisition on a complex signal using custom complex windows.

Weights are applied as:

\[\widetilde{A} = \int ( \mathrm{Re}(S(t))\cdot \mathrm{Re}(W_A(t)) + \mathrm{Im}(S(t))\cdot \mathrm{Im}(W_A(t)) ) \mathrm{d}t\]
\[\widetilde{B} = \int ( \mathrm{Re}(S(t))\cdot \mathrm{Re}(W_B(t)) + \mathrm{Im}(S(t))\cdot \mathrm{Im}(W_B(t)) ) \mathrm{d}t\]
Parameters:

  • waveform_a – The complex waveform used as integration weights \(A(t)\).

  • waveform_b – The complex waveform used as integration weights \(B(t)\).

  • port – The acquisition port.

  • clock – The clock used to demodulate the acquisition.

  • duration – The acquisition duration in seconds.

  • acq_channel – The data channel in which the acquisition is stored, by default 0. Describes the “where” information of the measurement, which typically corresponds to a qubit idx.

  • acq_index – The data register in which the acquisition is stored, by default 0. Describes the “when” information of the measurement, used to label or tag individual measurements in a large circuit. Typically corresponds to the setpoints of a schedule (e.g., tau in a T1 experiment).

  • bin_mode – Describes what is done when data is written to a register that already contains a value. Options are “append” which appends the result to the list or “average” which stores the weighted average value of the new result and the old register value, by default BinMode.APPEND

  • phase – The phase of the pulse and acquisition in degrees, by default 0

  • t0 – The acquisition start time in seconds, by default 0

Raises:

NotImplementedError –

class SSBIntegrationComplex(port: str, clock: str, duration: float, acq_channel: int = 0, acq_index: int = 0, bin_mode: Union[quantify_scheduler.enums.BinMode, str] = BinMode.AVERAGE, phase: float = 0, t0: float = 0)[source]#

Bases: AcquisitionOperation

This class implements a SingleSideBand Integration acquisition protocol with complex results.

Creates a new instance of SSBIntegrationComplex. Single Sideband Integration acquisition protocol with complex results.

A weighted integrated acquisition on a complex signal using a square window for the acquisition weights.

The signal is demodulated using the specified clock, and the square window then effectively specifies an integration window.

Parameters:

  • port – The acquisition port.

  • clock – The clock used to demodulate the acquisition.

  • duration – The acquisition duration in seconds.

  • acq_channel – The data channel in which the acquisition is stored, by default 0. Describes the “where” information of the measurement, which typically corresponds to a qubit idx.

  • acq_index – The data register in which the acquisition is stored, by default 0. Describes the “when” information of the measurement, used to label or tag individual measurements in a large circuit. Typically corresponds to the setpoints of a schedule (e.g., tau in a T1 experiment).

  • bin_mode – Describes what is done when data is written to a register that already contains a value. Options are “append” which appends the result to the list or “average” which stores the weighted average value of the new result and the old register value, by default BinMode.AVERAGE

  • phase – The phase of the pulse and acquisition in degrees, by default 0

  • t0 – The acquisition start time in seconds, by default 0

_is_increasing_at_constant_rate(array: Sequence[float]) → bool[source]#

Checks whether the array is increasing at a constant rate.

An array with size 2 is assumed to be increasing at a constant rate.

Examples

assert _is_increasing_at_constant_rate([1,2,3,4]) is True
assert _is_increasing_at_constant_rate([1,2,4]) is False
assert _is_increasing_at_constant_rate([4,3,2,1]) is False
assert _is_increasing_at_constant_rate([1,1,1]) is False
assert _is_increasing_at_constant_rate([2,1]) is False
assert _is_increasing_at_constant_rate([1]) is False
class ThresholdedAcquisition(port: str, clock: str, duration: float, acq_channel: int = 0, acq_index: int = 0, bin_mode: Union[quantify_scheduler.enums.BinMode, str] = BinMode.AVERAGE, phase: float = 0, t0: float = 0)[source]#

Bases: AcquisitionOperation

Create a new instance of ThresholdedAcquisition.

This acquisition protocol is similar to the SSBIntegrationComplex acquisition protocol, but the complex result is now rotated and thresholded to produce a “0” or a “1”, as controlled by the parameters for rotation angle <qubit>.measure.acq_rotation and threshold value <qubit>.measure.acq_threshold in the device configuration (see example below).

The rotation angle and threshold value for each qubit can be set through the device configuration

Note

Thresholded acquisition is currently only supported by the Qblox backend.

Examples

from quantify_scheduler import Schedule
from quantify_scheduler.device_under_test.transmon_element import BasicTransmonElement
from quantify_scheduler.operations.acquisition_library import ThresholdedAcquisition

# set up qubit
qubit = BasicTransmonElement("q0")
qubit.clock_freqs.readout(8.0e9)

# set rotation and threshold value
rotation, threshold = 20, -0.1
qubit.measure.acq_rotation(rotation)
qubit.measure.acq_threshold(threshold)

# basic schedule
schedule = Schedule("thresholded acquisition")
schedule.add(ThresholdedAcquisition(port="q0:res", clock="q0.ro", duration=1e-6))

{'name': 'cb0303fa-f157-4848-977e-8c7e84f06670', 'operation_repr': '7555711318118656789', 'timing_constraints': [{'rel_time': 0, 'ref_schedulable': None, 'ref_pt_new': None, 'ref_pt': None}], 'label': 'cb0303fa-f157-4848-977e-8c7e84f06670'}
Parameters:

  • port (str) – The acquisition port.

  • clock (str) – The clock used to demodulate the acquisition.

  • duration (float) – The acquisition duration in seconds.

  • acq_channel (int) – The data channel in which the acquisition is stored, by default 0. Describes the “where” information of the measurement, which typically corresponds to a qubit idx.

  • acq_index (int) – The data register in which the acquisition is stored, by default 0. Describes the “when” information of the measurement, used to label or tag individual measurements in a large circuit. Typically corresponds to the setpoints of a schedule (e.g., tau in a T1 experiment).

  • bin_mode (BinMode or str) – Describes what is done when data is written to a register that already contains a value. Options are “append” which appends the result to the list or “average” which stores the weighted average value of the new result and the old register value, by default BinMode.AVERAGE.

  • phase (float) – The phase of the pulse and acquisition in degrees, by default 0.

  • t0 (float) – The acquisition start time in seconds, by default 0.

class NumericalWeightedIntegrationComplex(port: str, clock: str, weights_a: Union[List[complex], numpy.ndarray], weights_b: Union[List[complex], numpy.ndarray], weights_sampling_rate: float = qblox_constants.SAMPLING_RATE, t: Optional[Union[List[float], numpy.ndarray]] = None, interpolation: str = 'linear', acq_channel: int = 0, acq_index: int = 0, bin_mode: Union[quantify_scheduler.enums.BinMode, str] = BinMode.APPEND, phase: float = 0, t0: float = 0)[source]#

Bases: WeightedIntegratedComplex

Implements a WeightedIntegratedComplex class using parameterized waveforms and interpolation as the integration weights.

Creates a new instance of NumericalWeightedIntegrationComplex. NumericalWeightedIntegrationComplex inherits from WeightedIntegratedComplex that uses parameterized waveforms and interpolation as integration weights.

Weights are applied as:

\[\widetilde{A} = \int ( \mathrm{Re}(S(t))\cdot \mathrm{Re}(W_A(t)) + \mathrm{Im}(S(t))\cdot \mathrm{Im}(W_A(t)) ) \mathrm{d}t\]
\[\widetilde{B} = \int ( \mathrm{Re}(S(t))\cdot \mathrm{Re}(W_B(t)) + \mathrm{Im}(S(t))\cdot \mathrm{Im}(W_B(t)) ) \mathrm{d}t\]
Parameters:

  • port – The acquisition port.

  • clock – The clock used to demodulate the acquisition.

  • weights_a – The list of complex values used as weights \(A(t)\) on the incoming complex signal.

  • weights_b – The list of complex values used as weights \(B(t)\) on the incoming complex signal.

  • weights_sampling_rate – The rate with which the weights have been sampled, in Hz. By default equal to the Qblox backend sampling rate. Note that during hardware compilation, the weights will be resampled with the sampling rate supported by the target hardware.

  • t – The time values of each weight. This parameter is deprecated in favor of weights_sampling_rate. If a value is provided for t, the weights_sampling_rate parameter will be ignored.

  • interpolation – The type of interpolation to use, by default “linear”. This argument is passed to interp1d.

  • acq_channel – The data channel in which the acquisition is stored, by default 0. Describes the “where” information of the measurement, which typically corresponds to a qubit idx.

  • acq_index – The data register in which the acquisition is stored, by default 0. Describes the “when” information of the measurement, used to label or tag individual measurements in a large circuit. Typically corresponds to the setpoints of a schedule (e.g., tau in a T1 experiment).

  • bin_mode – Describes what is done when data is written to a register that already contains a value. Options are “append” which appends the result to the list or “average” which stores the weighted average value of the new result and the old register value, by default BinMode.APPEND

  • phase – The phase of the pulse and acquisition in degrees, by default 0

  • t0 – The acquisition start time in seconds, by default 0

class TriggerCount(port: str, clock: str, duration: float, acq_channel: int = 0, acq_index: int = 0, bin_mode: Union[quantify_scheduler.enums.BinMode, str] = BinMode.APPEND, t0: float = 0)[source]#

Bases: AcquisitionOperation

Trigger counting acquisition protocol returning an integer.

Creates a new instance of TriggerCount, trigger counting acquisition protocol, returning an integer.

The trigger acquisition mode is used to measure how many times the trigger level is surpassed. The level is set in the hardware configuration.

Parameters:

  • port – The acquisition port.

  • clock – The clock used to demodulate the acquisition.

  • duration – The acquisition duration in seconds.

  • acq_channel – The data channel in which the acquisition is stored, by default 0. Describes the “where” information of the measurement, which typically corresponds to a qubit idx.

  • acq_index – The data register in which the acquisition is stored, by default 0. Describes the “when” information of the measurement, used to label or tag individual measurements in a large circuit. Typically corresponds to the setpoints of a schedule (e.g., tau in a T1 experiment).

  • bin_mode – Describes what is done when data is written to a register that already contains a value. Options are “append” which appends the result to the list or “average” which stores the count value of the new result and the old register value, by default BinMode.APPEND

  • t0 – The acquisition start time in seconds, by default 0