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.

CorrelatedReadoutErrorAnalysis

class CorrelatedReadoutErrorAnalysis

An analysis to characterize correlated readout error.

Overview

This class generates the full assignment matrix $A$ characterizing the readout error for the given qubits from the experiment results and returns the resulting CorrelatedReadoutMitigator

$A$ is a $2^n\times 2^n$ matrix $A$ such that $A_{y,x}$ is the probability to observe $y$ given the true outcome should be $x$.

In the experiment, for each $x‘acircuitisconstructedwhoseexpectedoutcomeis:math:‘x$. From the observed results on the circuit, the probability for each $y$ is determined, and $A_{y,x}$ is set accordingly.

Analysis Results:

• “Local Readout Mitigator”: The LocalReadoutMitigator.

Analysis Figures:

• (Optional) A figure of the assignment matrix.

References

[1] Sergey Bravyi, Sarah Sheldon, Abhinav Kandala, David C. Mckay, Jay M. Gambetta, Mitigating measurement errors in multi-qubit experiments, Phys. Rev. A 103, 042605 (2021), doi: 10.1103/PhysRevA.103.042605 (open)

Analysis options

These are the keyword arguments of run() method.

Options

• Defined in the class CorrelatedReadoutErrorAnalysis:

  • plot (bool)

    Default value: True

    Set True to create figure for fit result.

  • ax (AxesSubplot)

    Default value: None

    Optional. A matplotlib axis object to draw.

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

Initialization

Initialize the analysis object.

Attributes

CorrelatedReadoutErrorAnalysis.options

Return the analysis options for run() method.

Methods

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