class FrequencyCal(physical_qubits, calibrations, backend=None, cal_parameter_name='drive_freq', delays=None, osc_freq=2000000.0, auto_update=True)[source]

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

Analysis class reference


Experiment options

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

  • 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


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

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

  • backend (Backend | None) – Optional, the backend to run the experiment on.

  • cal_parameter_name (str | None) – The name of the parameter to update in the calibrations. This defaults to drive_freq.

  • delays (List | None) – 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.


analysis: BaseAnalysis

Return the analysis instance for the experiment.


Analysis instance set to calibration experiment is implicitly patched to run calibration updater to update the parameters in the calibration table.


Return the backend for the experiment


Return the calibrations.


Return the options for the experiment.


Return experiment type.


Return the number of qubits for the experiment.


Return the device qubits for the experiment.


Return options values for the experiment run() method.


Return the transpiler options for the run() method.



Create the circuits for the Ramsey XY characterization experiment.


A list of circuits with a variable delay.

Return type:



Return the config dataclass for this experiment

Return type:



Return a copy of the experiment

Return type:


enable_restless(rep_delay=None, override_processor_by_restless=True, suppress_t1_error=False)

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

  • rep_delay (float | None) – The repetition delay. This is the delay between a measurement and the subsequent quantum circuit. Since the backends have dynamic repetition rates, the repetition delay can be set to a small value which is required for restless experiments. Typical values are 1 us or less.

  • override_processor_by_restless (bool) – If False, a data processor that is specified in the analysis options of the experiment is not overridden by the restless data processor. The default is True.

  • suppress_t1_error (bool) – If True, the default is False, then no error will be raised when rep_delay is larger than the T1 times of the qubits. Instead, a warning will be logged as restless measurements may have a large amount of noise.

  • DataProcessorError – If the attribute rep_delay_range is not defined for the backend.

  • DataProcessorError – If a data processor has already been set but override_processor_by_restless is True.

  • DataProcessorError – If the experiment analysis does not have the data_processor option.

  • DataProcessorError – If the rep_delay is equal to or greater than the T1 time of one of the physical qubits in the experiment and the flag ignore_t1_check is False.

classmethod from_config(config)

Initialize an experiment from experiment config

Return type:



Get information about job distribution for the experiment on a specific backend.


backend (Backend) – Optional, the backend for which to get job distribution information. If not specified, the experiment must already have a set backend.


A dictionary containing information about job distribution.

  • ”Total number of circuits in the experiment”: Total number of circuits in the experiment.

  • ”Maximum number of circuits per job”: Maximum number of circuits in one job based on backend and experiment settings.

  • ”Total number of jobs”: Number of jobs needed to run this experiment on the currently set backend.

Return type:



QiskitError – if backend is not specified.

run(backend=None, analysis='default', timeout=None, **run_options)

Run an experiment and perform analysis.

  • backend (Backend | None) – Optional, the backend to run the experiment on. This will override any currently set backends for the single execution.

  • analysis (BaseAnalysis | None) – Optional, a custom analysis instance to use for performing analysis. If None analysis will not be run. If "default" the experiments analysis() instance will be used if it contains one.

  • timeout (float | None) – Time to wait for experiment jobs to finish running before cancelling.

  • run_options – backend runtime options used for circuit execution.


The experiment data object.


QiskitError – If experiment is run with an incompatible existing ExperimentData container.

Return type:



Set the experiment options.


fields – The fields to update the options


AttributeError – If the field passed in is not a supported options


Set options values for the experiment run() method.


fields – The fields to update the options

See also

The Setting options for your experiment guide for code example.


Add a warning message.


If your experiment has overridden _transpiled_circuits and needs transpile options then please also override set_transpile_options.


Update the frequency using the reported frequency less the imparted oscillation.