FrequencyCal

class FrequencyCal(qubit, 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 set_experiment_options() method.

Parameters:

• result_index (int) – The index of the result from which to update the calibrations.

• group (str) – The calibration group to which the parameter belongs. This will default to the value “default”.

Default values

Following values are set by default.

delays                    := array([0.0e+00, 2.0e-08, 4.0e-08, 6.0e-08, 8.0e-08, 1.0e-07, 1.2e-07,
       1.4e-07, 1.6e-07, 1.8e-07, 2.0e-07, 2.2e-07, 2.4e-07, 2.6e-07,
       2.8e-07, 3.0e-07, 3.2e-07, 3.4e-07, 3.6e-07, 3.8e-07, 4.0e-07,
       4.2e-07, 4.4e-07, 4.6e-07, 4.8e-07, 5.0e-07, 5.2e-07, 5.4e-07,
       5.6e-07, 5.8e-07, 6.0e-07, 6.2e-07, 6.4e-07, 6.6e-07, 6.8e-07,
       7.0e-07, 7.2e-07, 7.4e-07, 7.6e-07, 7.8e-07, 8.0e-07, 8.2e-07,
       8.4e-07, 8.6e-07, 8.8e-07, 9.0e-07, 9.2e-07, 9.4e-07, 9.6e-07,
       9.8e-07, 1.0e-06])
osc_freq                  := 2000000.0
result_index              := -1
group                     := 'default'

Transpiler Options

This option can be set by set_transpile_options() method.

This option is used for circuit optimization. See the documentation of qiskit.transpile for available options.

Default values

Following values are set by default.

optimization_level        := 0

Backend Run Options

This option can be set by set_run_options() method.

This option is used for controlling job execution condition. Note that this option is provider dependent. See provider’s backend runner API for available options. See the documentation of IBMQBackend.run for the IBM Quantum Service.

Default values

Following values are set by default.

meas_level                := <MeasLevel.CLASSIFIED: 2>

See also

Module(s) RamseyXY

Initialization

Parameters:

• qubit (int) – 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.analysis_options	Return the analysis options for run() analysis.
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, perform analysis, and update any calibrations.
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)	Set the transpiler options for run() method.
FrequencyCal.update_calibrations(experiment_data)	Update the frequency using the reported frequency less the imparted oscillation.