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.

FineFrequencyCal

class FineFrequencyCal(physical_qubits, calibrations, backend=None, delay_duration=None, repetitions=None, auto_update=True, gate_name='sx')

A calibration version of the fine frequency experiment.

Analysis class reference

ErrorAmplificationAnalysis

Experiment options

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

Options

• Defined in the class FineFrequencyCal:

  • dt (float)

    Default value: None

    The duration of the time unit dt of the delay and schedules in seconds.

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

  • repetitions (List[int])

    Default value: [0, 1, 2, 3, 4, …]

    A list of the number of times that the delay is repeated.

  • delay_duration (int)

    Default value: None

    The duration of the delay as the number of dt s it contains. The total length of the delay in units of dt will be n times delay_duration where n also determines the rotation angle of the RZGate by \(n \pi/2\).

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

Initialization

See class FineFrequency for details.

Note that this class implicitly assumes that the target angle of the gate is \(\pi/2\) as seen from the default analysis options. This experiment can be seen as a calibration of a finite duration rz(pi/2) gate with any error attributed to a frequency offset in the qubit.

Parameters:

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

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

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

• delay_duration (Optional[int]) – The duration of the delay at \(n=1\). If this value is not given then the duration of the gate named gate_name in the calibrations will be used.

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

• gate_name (str) – This argument is only needed if delay_duration is None. This should be the name of a valid schedule in the calibrations.

Attributes

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

Methods

FineFrequencyCal.circuits()	Return the list of quantum circuits to run.
FineFrequencyCal.config()	Return the config dataclass for this experiment
FineFrequencyCal.copy()	Return a copy of the experiment
FineFrequencyCal.from_config(config)	Initialize an experiment from experiment config
FineFrequencyCal.run([backend, analysis, ...])	Run an experiment and perform analysis.
FineFrequencyCal.set_experiment_options(**fields)	Set the experiment options.
FineFrequencyCal.set_run_options(**fields)	Set options values for the experiment run() method.
FineFrequencyCal.set_transpile_options(**fields)	Add a warning message.
FineFrequencyCal.update_calibrations(...)	Update the qubit frequency based on the measured angle deviation.