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.

ExperimentData.analysis_results

ExperimentData.analysis_results(index=None, refresh=False, block=True, timeout=None)[source]

Return analysis results associated with this experiment.

Parameters:

  • index (Union[int, slice, str, None]) –

    Index of the analysis result to be returned. Several types are accepted for convenience:

    • None: Return all analysis results.

    • int: Specific index of the analysis results.

    • slice: A list slice of indexes.

    • str: ID or name of the analysis result.

  • refresh (bool) – Retrieve the latest analysis results from the server, if an experiment service is available.

  • block (bool) – If True block for any analysis callbacks to finish running.

  • timeout (Optional[float]) – max time in seconds to wait for analysis callbacks to finish running.

Return type:

Union[AnalysisResult, List[AnalysisResult]]

Returns:

Analysis results for this experiment.

Raises: