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.

MitigatedTomographyAnalysis

class MitigatedTomographyAnalysis(roerror_analysis='default', tomography_analysis='default')

Analysis for readout error mitigated tomography experiments.

Analysis is performed as a CompositeAnalysis consisting of LocalReadoutErrorAnalysis to determine the local assignment matrices describing single qubit Z-basis readout errors, and then these matrices are used to automatically construct a noisy PauliMeasurementBasis for use during tomographic fitting with the tomography analysis.

Analysis options

These are the keyword arguments of run() method.

Options

• Defined in the class MitigatedTomographyAnalysis:

  • fitter (str or Callable)

    Default value: "linear_inversion"

    The fitter function to use for reconstruction. This can be a string to select one of the built-in fitters, or a callable to supply a custom fitter function. See the Fitter Functions section for additional information.

  • fitter_options (dict)

    Default value: {}

    Any addition kwarg options to be supplied to the fitter function. For documentation of available kwargs refer to the fitter function documentation.

  • rescale_positive (bool)

    Default value: True

    If True rescale the state returned by the fitter to be positive-semidefinite. See the PSD Rescaling section for additional information (Default: True).

  • rescale_trace (bool)

    Default value: True

    If True rescale the state returned by the fitter have either trace 1 for DensityMatrix, or trace dim for Choi matrices (Default: True).

  • measurement_qubits (Sequence[int])

    Default value: None

    Optional, the physical qubits with tomographic measurements. If not specified will be set to [0, ..., N-1] for N-qubit tomographic measurements.

  • preparation_qubits (Sequence[int])

    Default value: None

    Optional, the physical qubits with tomographic preparations. If not specified will be set to [0, ..., N-1] for N-qubit tomographic preparations.

  • unmitigated_fit (bool)

    Default value: False

    If True also run tomography fit without readout error mitigation and include both mitigated and unmitigated analysis results. If False only compute mitigated results (Default: False)

  • target (Any)

    Default value: None

    Optional, target object for fidelity comparison of the fit (Default: None).

• 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.framework.composite.composite_analysis.CompositeAnalysis

Initialization

Initialize mitigated tomography analysis

Attributes

MitigatedTomographyAnalysis.options

Return the analysis options for run() method.

Methods

MitigatedTomographyAnalysis.component_analysis([index])	Return the component experiment Analysis instance.
MitigatedTomographyAnalysis.config()	Return the config dataclass for this analysis
MitigatedTomographyAnalysis.copy()	Return a copy of the analysis
MitigatedTomographyAnalysis.from_config(config)	Initialize an analysis class from analysis config
MitigatedTomographyAnalysis.run(experiment_data)	Run analysis and update ExperimentData with analysis result.
MitigatedTomographyAnalysis.set_options(**fields)	Set the analysis options for run() method.