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.

MitigatedStateTomography

class MitigatedStateTomography(circuit, backend=None, physical_qubits=None, measurement_indices=None, basis_indices=None, conditional_circuit_clbits=False, analysis='default')[source]

A batched experiment to characterize readout error then perform state tomography for doing readout error mitigated state tomography.

Overview

Readout error mitigated quantum state tomography is a batch experiment consisting of a LocalReadoutError characterization experiments, followed by a StateTomography experiment.

During analysis the assignment matrix local readout error model is used to automatically construct a noisy Pauli measurement basis for performing readout error mitigated state tomography fitting.

Analysis class reference

MitigatedTomographyAnalysis

Experiment options

These options can be set by the set_experiment_options() method.

Options
  • Defined in the class BatchExperiment:

    • separate_jobs (Boolean)

      Default value: False
      Whether to route different sub-experiments to different jobs.
  • Defined in the class BaseExperiment:

    • max_circuits (Optional[int])

      Default value: None
      The maximum number of circuits per job when running an experiment on a backend.

Note

Performing readout error mitigation full state tomography on an N-qubit circuit requires running 2 readout error characterization circuits and 3N measurement circuits using the Pauli measurement basis.

See also

Initialization

Initialize a quantum process tomography experiment.

Parameters:
  • circuit (Union[QuantumCircuit, Instruction, BaseOperator]) – the quantum process circuit. If not a quantum circuit it must be a class that can be appended to a quantum circuit.

  • backend (Optional[Backend]) – The backend to run the experiment on.

  • physical_qubits (Optional[Sequence[int]]) – Optional, the physical qubits for the initial state circuit. If None this will be qubits [0, N) for an N-qubit circuit.

  • measurement_indices (Optional[Sequence[int]]) – Optional, the physical_qubits indices to be measured. If None all circuit physical qubits will be measured.

  • basis_indices (Optional[Sequence[List[int]]]) – Optional, a list of basis indices for generating partial tomography measurement data. Each item should be given as a list of measurement basis configurations [m[0], m[1], ...] where m[i] is the measurement basis index for qubit-i. If not specified full tomography for all indices of the measurement basis will be performed.

  • conditional_circuit_clbits (Union[bool, Sequence[int], Sequence[Clbit]]) – Optional, the clbits in the source circuit to be conditioned on when reconstructing the state. If True all circuit clbits will be conditioned on. Enabling this will return a list of reconstrated state components conditional on the values of these clbit values.

  • analysis (Union[BaseAnalysis, None, str]) – Optional, a custom tomography analysis instance to use. If "default" ProcessTomographyAnalysis will be used. If None no analysis instance will be set.

Attributes

MitigatedStateTomography.analysis

Return the analysis instance for the experiment

MitigatedStateTomography.backend

Return the backend for the experiment

MitigatedStateTomography.experiment_options

Return the options for the experiment.

MitigatedStateTomography.experiment_type

Return experiment type.

MitigatedStateTomography.num_experiments

Return the number of sub experiments

MitigatedStateTomography.num_qubits

Return the number of qubits for the experiment.

MitigatedStateTomography.physical_qubits

Return the device qubits for the experiment.

MitigatedStateTomography.run_options

Return options values for the experiment run() method.

MitigatedStateTomography.transpile_options

Return the transpiler options for the run() method.

Methods

MitigatedStateTomography.circuits()

Return a list of experiment circuits.

MitigatedStateTomography.component_experiment([index])

Return the component Experiment object.

MitigatedStateTomography.config()

Return the config dataclass for this experiment

MitigatedStateTomography.copy()

Return a copy of the experiment

MitigatedStateTomography.from_config(config)

Initialize an experiment from experiment config

MitigatedStateTomography.run([backend, ...])

Run an experiment and perform analysis.

MitigatedStateTomography.set_experiment_options(...)

Set the experiment options.

MitigatedStateTomography.set_run_options(...)

Set options values for the experiment run() method.

MitigatedStateTomography.set_transpile_options(...)

Set the transpiler options for run() method.