Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

ReadoutAngle

class ReadoutAngle(physical_qubits, backend=None)[source]

An experiment to measure the angle between ground and excited state IQ clusters.

Overview

Design and analyze experiments for estimating readout angle of the qubit. The readout angle is the average of two angles: the angle of the IQ cluster center of the ground state, and the angle of the IQ cluster center of the excited state.

Each experiment consists of the following steps:

  1. Circuits generation: two circuits, the first circuit measures the qubit in the ground state, the second circuit sets the qubit in the excited state and measures it. Measurements are in level 1 (kerneled).

  2. Backend execution: actually running the circuits on the device (or a simulator that supports level 1 measurements). The backend returns the cluster centers of the ground and excited states.

  3. Analysis of results: return the average of the angles of the two centers.


Analysis class reference

ReadoutAngleAnalysis

Experiment options

These options can be set by the set_experiment_options() method.

Options
  • Defined in the class BaseExperiment:

    • max_circuits (Optional[int])

      Default value: None
      The maximum number of circuits per job when running an experiment on a backend.

Initialization

Initialize the readout angle experiment class

Parameters:
  • physical_qubits (Sequence[int]) – a single-element sequence containing the qubit whose readout angle is to be estimated

  • backend (Optional[Backend]) – Optional, the backend to run the experiment on.

Attributes

ReadoutAngle.analysis

Return the analysis instance for the experiment

ReadoutAngle.backend

Return the backend for the experiment

ReadoutAngle.experiment_options

Return the options for the experiment.

ReadoutAngle.experiment_type

Return experiment type.

ReadoutAngle.num_qubits

Return the number of qubits for the experiment.

ReadoutAngle.physical_qubits

Return the device qubits for the experiment.

ReadoutAngle.run_options

Return options values for the experiment run() method.

ReadoutAngle.transpile_options

Return the transpiler options for the run() method.

Methods

ReadoutAngle.circuits()

Return a list of experiment circuits

ReadoutAngle.config()

Return the config dataclass for this experiment

ReadoutAngle.copy()

Return a copy of the experiment

ReadoutAngle.from_config(config)

Initialize an experiment from experiment config

ReadoutAngle.run([backend, analysis, timeout])

Run an experiment and perform analysis.

ReadoutAngle.set_experiment_options(**fields)

Set the experiment options.

ReadoutAngle.set_run_options(**fields)

Set options values for the experiment run() method.

ReadoutAngle.set_transpile_options(**fields)

Set the transpiler options for run() method.