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.

FineSXAmplitude

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

A fine amplitude experiment with all the options set for the π/2-rotation.

Overview

FineSXAmplitude is a subclass of FineAmplitude and is used to set the appropriate values for the default options.

Analysis class reference

FineAmplitudeAnalysis

Experiment options

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

Options
  • Defined in the class FineSXAmplitude:

    • gate (Gate)

      Default value: Instance of SXGate
      FineSXAmplitude calibrates an SXGate.
    • add_cal_circuits (bool)

      Default value: False
      If set to True then two circuits to calibrate 0 and 1 points will be added. This option is set to False by default for FineSXAmplitude since the amplitude calibration can be achieved with two SX gates and this is included in the repetitions.
    • repetitions (List[int])

      Default value: [0, 1, 2, 3, 5, …]
      By default the repetitions take on odd numbers for π/2 target angles as this ideally prepares states on the equator of the Bloch sphere. Note that the repetitions include two repetitions which plays the same role as including a circuit with an X gate.
  • Defined in the class FineAmplitude:

    • normalization (bool)

      Default value: True
      If set to True the DataProcessor will normalized the measured signal to the interval [0, 1]. Defaults to True.
  • 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.

See also

Initialization

Initialize the experiment.

Attributes

FineSXAmplitude.analysis

Return the analysis instance for the experiment

FineSXAmplitude.backend

Return the backend for the experiment

FineSXAmplitude.experiment_options

Return the options for the experiment.

FineSXAmplitude.experiment_type

Return experiment type.

FineSXAmplitude.num_qubits

Return the number of qubits for the experiment.

FineSXAmplitude.physical_qubits

Return the device qubits for the experiment.

FineSXAmplitude.run_options

Return options values for the experiment run() method.

FineSXAmplitude.transpile_options

Return the transpiler options for the run() method.

Methods

FineSXAmplitude.circuits()

Create the circuits for the fine amplitude calibration experiment.

FineSXAmplitude.config()

Return the config dataclass for this experiment

FineSXAmplitude.copy()

Return a copy of the experiment

FineSXAmplitude.enable_restless([rep_delay, ...])

Enables a restless experiment by setting the restless run options and the restless data processor.

FineSXAmplitude.from_config(config)

Initialize an experiment from experiment config

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

Run an experiment and perform analysis.

FineSXAmplitude.set_experiment_options(**fields)

Set the experiment options.

FineSXAmplitude.set_run_options(**fields)

Set options values for the experiment run() method.

FineSXAmplitude.set_transpile_options(**fields)

Set the transpiler options for run() method.