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.

ReadoutAngleAnalysis

class ReadoutAngleAnalysis[source]

A class to analyze readout angle experiments

Analysis options

These are the keyword arguments of run() method.

Options
  • Defined in the class ReadoutAngleAnalysis:

    • 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

ReadoutAngleAnalysis.options

Return the analysis options for run() method.

Methods

ReadoutAngleAnalysis.config()

Return the config dataclass for this analysis

ReadoutAngleAnalysis.copy()

Return a copy of the analysis

ReadoutAngleAnalysis.from_config(config)

Initialize an analysis class from analysis config

ReadoutAngleAnalysis.run(experiment_data[, ...])

Run analysis and update ExperimentData with analysis result.

ReadoutAngleAnalysis.set_options(**fields)

Set the analysis options for run() method.