Table of Contents

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.

BaseAnalysis.run

BaseAnalysis.run(experiment_data, replace_results=False, **options)[source]

Run analysis and update ExperimentData with analysis result.

Parameters:

  • experiment_data (ExperimentData) – the experiment data to analyze.

  • replace_results (bool) – If True clear any existing analysis results and figures in the experiment data and replace with new results. See note for additional information.

  • options – additional analysis options. See class documentation for supported options.

Return type:

ExperimentData

Returns:

An experiment data object containing the analysis results and figures.

Raises:

QiskitError – If experiment_data container is not valid for analysis.

Note

Updating Results

If analysis is run with replace_results=True then any analysis results and figures in the experiment data will be cleared and replaced with the new analysis results. Saving this experiment data will replace any previously saved data in a database service using the same experiment ID.

If analysis is run with replace_results=False and the experiment data being analyzed has already been saved to a database service, or already contains analysis results or figures, a copy with a unique experiment ID will be returned containing only the new analysis results and figures. This data can then be saved as its own experiment to a database service.