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

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⟩,|1⟩\}$.

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

$$\begin{array}{rl}ZX& =\frac{p_{x,|0⟩}-p_{x,|1⟩}}{2},\\ ZY& =\frac{p_{y,|0⟩}-p_{y,|1⟩}}{2},\\ ZZ& =\frac{p_{z,|0⟩}-p_{z,|1⟩}}{2},\\ IX& =\frac{p_{x,|0⟩}+p_{x,|1⟩}}{2},\\ IY& =\frac{p_{y,|0⟩}+p_{y,|1⟩}}{2},\\ IZ& =\frac{p_{z,|0⟩}+p_{z,|1⟩}}{2},\end{array}$$

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

Analysis options

These are the keyword arguments of 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: True

    Set True to return all fit model parameters with details of the fit outcome. Default to True.

  • return_data_points (bool)

    Default value: False

    Set True to include in the analysis result the formatted data points given to the fitter. 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.

See also

• Superclass qiskit_experiments.curve_analysis.composite_curve_analysis.CompositeCurveAnalysis

Initialization

Initialize the analysis object.

Attributes

CrossResonanceHamiltonianAnalysis.drawer	A short-cut for curve drawer instance, if set.
CrossResonanceHamiltonianAnalysis.models	Return fit models.
CrossResonanceHamiltonianAnalysis.name	Return name of this analysis.
CrossResonanceHamiltonianAnalysis.options	Return the analysis options for run() method.
CrossResonanceHamiltonianAnalysis.parameters	Return parameters of this curve analysis.
CrossResonanceHamiltonianAnalysis.plotter	A short-cut to the plotter instance.

Methods

CrossResonanceHamiltonianAnalysis.analyses([index])	Return curve analysis instance.
CrossResonanceHamiltonianAnalysis.config()	Return the config dataclass for this analysis
CrossResonanceHamiltonianAnalysis.copy()	Return a copy of the analysis
CrossResonanceHamiltonianAnalysis.from_config(config)	Initialize an analysis class from analysis config
CrossResonanceHamiltonianAnalysis.run(...[, ...])	Run analysis and update ExperimentData with analysis result.
CrossResonanceHamiltonianAnalysis.set_options(...)	Set the analysis options for run() method.