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.

EFSpectroscopy¶

class EFSpectroscopy(physical_qubits, frequencies, backend=None, absolute=True)[source]¶

A spectroscopy experiment to obtain a frequency sweep of the qubit’s e-f transition.

Overview

The circuits produced by spectroscopy, i.e.

           ┌───┐┌────────────┐ ░ ┌─┐
      q_0: ┤ X ├┤ Spec(freq) ├─░─┤M├
           └───┘└────────────┘ ░ └╥┘
measure: 1/═══════════════════════╩═
                                  0

Analysis class reference

ResonanceAnalysis

Experiment options

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

Options

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.library.characterization.qubit_spectroscopy.QubitSpectroscopy
Superclass qiskit_experiments.library.characterization.spectroscopy.Spectroscopy

Initialization

A spectroscopy experiment where the frequency of a pulse is scanned.

Parameters:

physical_qubits (Sequence[int]) – List containing the qubit on which to run spectroscopy.
frequencies (Iterable[float]) – The frequencies to scan in the experiment, in Hz.
backend (Optional[Backend]) – Optional, the backend to run the experiment on.
absolute (bool) – Boolean to specify if the frequencies are absolute or relative to the qubit frequency in the backend.
analysis – An instance of the analysis class to use.
experiment_options – Key word arguments used to set the experiment options.

Raises:

QiskitError – If there are less than three frequency shifts.

Attributes

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

Methods

`EFSpectroscopy.circuits`()	Create the circuit for the spectroscopy experiment.
`EFSpectroscopy.config`()	Return the config dataclass for this experiment
`EFSpectroscopy.copy`()	Return a copy of the experiment
`EFSpectroscopy.from_config`(config)	Initialize an experiment from experiment config
`EFSpectroscopy.run`([backend, analysis, timeout])	Run an experiment and perform analysis.
`EFSpectroscopy.set_experiment_options`(**fields)	Set the experiment options.
`EFSpectroscopy.set_run_options`(**fields)	Set options values for the experiment `run()` method.
`EFSpectroscopy.set_transpile_options`(**fields)	Set the transpiler options for `run()` method.