RoughFrequencyCal

class RoughFrequencyCal(physical_qubits, calibrations, frequencies, backend=None, auto_update=True, absolute=True)

A calibration experiment that runs QubitSpectroscopy to calibrate the qubit transition frequency.

Analysis class reference

ResonanceAnalysis

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

  • amp (float)

    Default value: 0.1

    The amplitude of the spectroscopy pulse. Defaults to 0.1 and must be between 0 and 1.

  • duration (int)

    Default value: 2.4e-07

    The duration of the spectroscopy pulse. Defaults to 1024 samples.

  • sigma (float)

    Default value: 6e-08

    The standard deviation of the flanks of the spectroscopy pulse. Defaults to 256.

  • width (int)

    Default value: 0

    The width of the flat-top part of the GaussianSquare pulse. Defaults to 0.

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

• Superclass qiskit_experiments.library.characterization.spectroscopy.Spectroscopy

Initialization

See QubitSpectroscopy for detailed documentation.

Parameters:

• physical_qubits (Sequence[int]) – List with the qubit on which to run spectroscopy.

• calibrations (Calibrations) – If calibrations is given then running the experiment may update the values of the frequencies stored in calibrations.

• frequencies (Iterable[float]) – The frequencies to scan in the experiment, in Hz.

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

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

• absolute (bool) – Boolean to specify if the frequencies are absolute or relative to the qubit frequency in the backend.

Raises:

QiskitError – If there are less than three frequency shifts.

Attributes

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

Methods

RoughFrequencyCal.circuits()	Create the circuit for the spectroscopy experiment.
RoughFrequencyCal.config()	Return the config dataclass for this experiment
RoughFrequencyCal.copy()	Return a copy of the experiment
RoughFrequencyCal.from_config(config)	Initialize an experiment from experiment config
RoughFrequencyCal.run([backend, analysis, ...])	Run an experiment and perform analysis.
RoughFrequencyCal.set_experiment_options(...)	Set the experiment options.
RoughFrequencyCal.set_run_options(**fields)	Set options values for the experiment run() method.
RoughFrequencyCal.set_transpile_options(**fields)	Add a warning message.
RoughFrequencyCal.update_calibrations(...)	Update parameter values in the Calibrations instance.