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.

Characterization Experiments (qiskit_experiments.library.characterization)

Experiments

T1(physical_qubits, delays[, backend])	An experiment to measure the qubit relaxation time.
T2Ramsey(physical_qubits, delays[, backend, ...])	An experiment to measure the Ramsey frequency and the qubit dephasing time sensitive to inhomogeneous broadening.
T2Hahn(physical_qubits, delays[, ...])	An experiment to measure the dephasing time insensitive to inhomogeneous broadening using Hahn echos.
Tphi(physical_qubits, delays_t1, delays_t2)	An experiment to measure the qubit dephasing rate in the \(x - y\) plane.
QubitSpectroscopy(physical_qubits, frequencies)	A spectroscopy experiment to obtain a frequency sweep of the qubit.
CrossResonanceHamiltonian(physical_qubits[, ...])	Cross resonance Hamiltonian tomography experiment.
EchoedCrossResonanceHamiltonian(physical_qubits)	Echoed cross resonance Hamiltonian tomography experiment.
Rabi(physical_qubits, schedule[, ...])	An experiment that scans a pulse amplitude to calibrate rotations on the \(|0\rangle\) <-> \(|1\rangle\) transition.
EFRabi(physical_qubits, schedule[, ...])	An experiment that scans the amplitude of a pulse inducing rotations on the \(|1\rangle\) <-> \(|2\rangle\) transition.
HalfAngle(physical_qubits[, backend])	An experiment class to measure the amount by which sx and x are not parallel.
FineAmplitude(physical_qubits, gate[, ...])	An experiment to determine the optimal pulse amplitude by amplifying gate errors.
FineXAmplitude(physical_qubits[, backend])	A fine amplitude experiment with all the options set for the \(\pi\)-rotation.
FineSXAmplitude(physical_qubits[, backend])	A fine amplitude experiment with all the options set for the \(\pi/2\)-rotation.
FineZXAmplitude(physical_qubits[, backend])	A fine amplitude experiment for the RZXGate(np.pi / 2).
RamseyXY(physical_qubits[, backend, delays, ...])	A sign-sensitive experiment to measure the frequency of a qubit.
FineFrequency(physical_qubits, delay_duration)	An experiment to make a fine measurement of the qubit frequency.
RoughDrag(physical_qubits, schedule[, ...])	An experiment that scans the DRAG parameter to find the optimal value.
ReadoutAngle(physical_qubits[, backend])	An experiment to measure the angle between ground and excited state IQ clusters.
FineDrag(physical_qubits, gate[, backend])	An experiment that performs fine characterizations of DRAG pulse coefficients.
FineXDrag(physical_qubits[, backend])	Class to fine characterize the DRAG parameter of an X gate.
FineSXDrag(physical_qubits[, backend])	Class to fine characterize the DRAG parameter of an \(SX\) gate.
LocalReadoutError([physical_qubits, backend])	An experiment for characterizing local readout error.
CorrelatedReadoutError([physical_qubits, ...])	Correlated readout error characterization experiment.
ResonatorSpectroscopy(physical_qubits[, ...])	An experiment to perform frequency spectroscopy of the readout resonator.
MultiStateDiscrimination(physical_qubits[, ...])	An experiment that discriminates between the first \(n\) energy states.
ZZRamsey(physical_qubits[, backend])	An experiment to characterize the static \(ZZ\) interaction for a qubit pair.

Analysis

T1Analysis([name])	A class to analyze T1 experiments.
T1KerneledAnalysis([name])	A class to analyze T1 experiments with kerneled data.
T2RamseyAnalysis([name])	T2 Ramsey result analysis class.
T2HahnAnalysis([name])	A class to analyze T2Hahn experiments.
TphiAnalysis([analyses])	A class to analyze \(T_\phi\) experiments.
CrossResonanceHamiltonianAnalysis()	A class to analyze cross resonance Hamiltonian tomography experiment.
DragCalAnalysis([models, name])	Drag calibration analysis based on a fit to a cosine function.
FineAmplitudeAnalysis()	An analysis class for fine amplitude calibrations to define the fixed parameters.
RamseyXYAnalysis()	Ramsey XY analysis based on a fit to a cosine function and a sine function.
ReadoutAngleAnalysis()	A class to analyze readout angle experiments
ResonatorSpectroscopyAnalysis([name])	Class to analysis resonator spectroscopy.
LocalReadoutErrorAnalysis()	Local readout error characterization analysis # section: overview
CorrelatedReadoutErrorAnalysis()	An analysis to characterize correlated readout error.
ZZRamseyAnalysis()	A class to analyze a \(ZZ\) Ramsey experiment.
MultiStateDiscriminationAnalysis()	This class fits a multi-state discriminator to the data.