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.

CrossResonanceHamiltonianAnalysis¶

class CrossResonanceHamiltonianAnalysis[source]¶

A class to analyze cross resonance Hamiltonian tomography experiment.

Fit model

This is the curve fitting analysis. The following equation(s) are used to represent curve(s).

This analysis performs BlochTrajectoryAnalysis on the target qubit with the control qubit states in \(\in \{ |0\rangle, |1\rangle \}\).

Based on the fit result, cross resonance Hamiltonian coefficients can be determined by

\[\begin{split}ZX &= \frac{p_{x, |0\rangle} - p_{x, |1\rangle}}{2}, \\ ZY &= \frac{p_{y, |0\rangle} - p_{y, |1\rangle}}{2}, \\ ZZ &= \frac{p_{z, |0\rangle} - p_{z, |1\rangle}}{2}, \\ IX &= \frac{p_{x, |0\rangle} + p_{x, |1\rangle}}{2}, \\ IY &= \frac{p_{y, |0\rangle} + p_{y, |1\rangle}}{2}, \\ IZ &= \frac{p_{z, |0\rangle} + p_{z, |1\rangle}}{2},\end{split}\]

where \(p_{\beta, |j\rangle}\) is a fit parameter of BlochTrajectoryAnalysis for the projection axis \(\beta\) with the control qubit state \(|j\rangle\).

Analysis options

These are the keyword arguments of the run() method.

Options

Defined in the class CompositeCurveAnalysis:
- plotter (BasePlotter)
  
  Default value: Instance of CurvePlotter
  
  A plotter instance to visualize the analysis result.
- plot (bool)
  
  Default value: True
  
  Set True to create figure for fit result. This is True by default.
- return_fit_parameters (bool)
  
  Default value: False
  
  (Deprecated) Set True to return all fit model parameters with details of the fit outcome. Default to False.
- extra (Dict[str, Any])
  
  Default value: {}
  
  A dictionary that is appended to all database entries as extra information.
Defined in the class BaseAnalysis:
- figure_names (str or List[str])
  
  Default value: None
  
  Identifier of figures that appear in the experiment data to sort figures by name.