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.

FineXAmplitude

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

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

Overview

FineXAmplitude 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 FineXAmplitude:

    • gate (Gate)

      Default value: Instance of XGate
      Gate to characterize. Defaults to an XGate.
  • Defined in the class FineAmplitude:

    • repetitions (List[int])

      Default value: [1, 2, 3, 4, 5, …]
      A list of the number of times that the gate is repeated.
    • normalization (bool)

      Default value: True
      If set to True the DataProcessor will normalized the measured signal to the interval [0, 1]. Defaults to True.
    • add_cal_circuits (bool)

      Default value: True
      If set to True then two circuits to calibrate 0 and 1 points will be added. These circuits are often needed to properly calibrate the amplitude of the ping-pong oscillation that encodes the errors. This helps account for state preparation and measurement errors.
  • 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

FineXAmplitude.analysis

Return the analysis instance for the experiment

FineXAmplitude.backend

Return the backend for the experiment

FineXAmplitude.experiment_options

Return the options for the experiment.

FineXAmplitude.experiment_type

Return experiment type.

FineXAmplitude.num_qubits

Return the number of qubits for the experiment.

FineXAmplitude.physical_qubits

Return the device qubits for the experiment.

FineXAmplitude.run_options

Return options values for the experiment run() method.

FineXAmplitude.transpile_options

Return the transpiler options for the run() method.

Methods

FineXAmplitude.circuits()

Create the circuits for the fine amplitude calibration experiment.

FineXAmplitude.config()

Return the config dataclass for this experiment

FineXAmplitude.copy()

Return a copy of the experiment

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

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

FineXAmplitude.from_config(config)

Initialize an experiment from experiment config

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

Run an experiment and perform analysis.

FineXAmplitude.set_experiment_options(**fields)

Set the experiment options.

FineXAmplitude.set_run_options(**fields)

Set options values for the experiment run() method.

FineXAmplitude.set_transpile_options(**fields)

Set the transpiler options for run() method.