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.

FrequencyCal

class FrequencyCal(physical_qubits, calibrations, backend=None, delays=None, osc_freq=2000000.0, auto_update=True)

A qubit frequency calibration experiment based on the Ramsey XY experiment.

Analysis class reference

RamseyXYAnalysis

Experiment options

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

Options

• 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 RamseyXY:

  • delays (list)

    Default value: array(0.0, 2e-08, 4e-08, 6.000000000000001e-08, 8e-08, ..., size=51)

    The list of delays that will be scanned in the experiment, in seconds.

  • osc_freq (float)

    Default value: 2000000.0

    A frequency shift in Hz that will be applied by means of a virtual Z rotation to increase the frequency of the measured oscillation.

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

Initialization

Parameters:

• physical_qubits (Sequence[int]) – Sequence containing the qubit on which to run the frequency calibration.

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

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

• delays (Optional[List]) – The list of delays that will be scanned in the experiment, in seconds.

• osc_freq (float) – A frequency shift in Hz that will be applied by means of a virtual Z rotation to increase the frequency of the measured oscillation.

• auto_update (bool) – If set to True, which is the default, then the experiment will automatically update the frequency in the calibrations.

Attributes

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

Methods

FrequencyCal.circuits()	Create the circuits for the Ramsey XY characterization experiment.
FrequencyCal.config()	Return the config dataclass for this experiment
FrequencyCal.copy()	Return a copy of the experiment
FrequencyCal.enable_restless([rep_delay, ...])	Enables a restless experiment by setting the restless run options and the restless data processor.
FrequencyCal.from_config(config)	Initialize an experiment from experiment config
FrequencyCal.run([backend, analysis, timeout])	Run an experiment and perform analysis.
FrequencyCal.set_experiment_options(**fields)	Set the experiment options.
FrequencyCal.set_run_options(**fields)	Set options values for the experiment run() method.
FrequencyCal.set_transpile_options(**fields)	Add a warning message.
FrequencyCal.update_calibrations(experiment_data)	Update the frequency using the reported frequency less the imparted oscillation.