FineAmplitudeCal

class FineAmplitudeCal(physical_qubits, calibrations, schedule_name, backend=None, cal_parameter_name='amp', auto_update=True, gate=None, measurement_qubits=None)

A calibration version of the FineAmplitude experiment.

Overview

FineAmplitudeCal is a subclass of FineAmplitude. In the calibration experiment the circuits that are run have a custom gate with the pulse schedule attached to it through the calibrations.

Analysis class reference

FineAmplitudeAnalysis

Experiment options

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

Options

• Defined in the class FineAmplitudeCal:

  • target_angle (float)

    Default value: 3.141592653589793

    The target angle of the pulse.

• Defined in the class BaseCalibrationExperiment:

  • result_index (int)

    Default value: -1

    The index of the result from which to update the calibrations.

  • group (str)

    Default value: "default"

    The calibration group to which the parameter belongs. This will default to the value “default”.

• 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.

  • gate (Gate)

    Default value: None

    This is a gate class such as XGate, so that one can obtain a gate by doing options.gate().

  • 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

• Superclass qiskit_experiments.calibration_management.base_calibration_experiment.BaseCalibrationExperiment

• Superclass qiskit_experiments.library.characterization.fine_amplitude.FineAmplitude

Initialization

See class FineAmplitude for details.

Parameters:

• physical_qubits (Sequence[int]) – Sequence containing the qubit(s) for which to run the fine amplitude calibration. This can be a pair of qubits which correspond to control and target qubit.

• calibrations (Calibrations) – The calibrations instance with the schedules.

• schedule_name (str) – The name of the schedule to calibrate.

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

• cal_parameter_name (Optional[str]) – The name of the parameter in the schedule to update.

• auto_update (bool) – Whether or not to automatically update the calibrations. By default this variable is set to True.

• gate (Optional[Gate]) – The gate to repeat in the quantum circuit. If this argument is None (the default), then the gate is built from the schedule name.

• measurement_qubits (Optional[Sequence[int]]) – The qubits in the given physical qubits that need to be measured.

Attributes

FineAmplitudeCal.analysis	Return the analysis instance for the experiment.
FineAmplitudeCal.backend	Return the backend for the experiment
FineAmplitudeCal.calibrations	Return the calibrations.
FineAmplitudeCal.experiment_options	Return the options for the experiment.
FineAmplitudeCal.experiment_type	Return experiment type.
FineAmplitudeCal.num_qubits	Return the number of qubits for the experiment.
FineAmplitudeCal.physical_qubits	Return the device qubits for the experiment.
FineAmplitudeCal.run_options	Return options values for the experiment run() method.
FineAmplitudeCal.transpile_options	Return the transpiler options for the run() method.

Methods

FineAmplitudeCal.circuits()	Create the circuits for the fine amplitude calibration experiment.
FineAmplitudeCal.config()	Return the config dataclass for this experiment
FineAmplitudeCal.copy()	Return a copy of the experiment
FineAmplitudeCal.enable_restless([...])	Enables a restless experiment by setting the restless run options and the restless data processor.
FineAmplitudeCal.from_config(config)	Initialize an experiment from experiment config
FineAmplitudeCal.run([backend, analysis, ...])	Run an experiment and perform analysis.
FineAmplitudeCal.set_experiment_options(**fields)	Set the experiment options.
FineAmplitudeCal.set_run_options(**fields)	Set options values for the experiment run() method.
FineAmplitudeCal.set_transpile_options(**fields)	Add a warning message.
FineAmplitudeCal.update_calibrations(...)	Update the amplitude of the pulse in the calibrations.