Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

qiskit.providers.ibmq.experiment.AnalysisResult

class AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=<ResultQuality.UNKNOWN: 'No Information'>, tags=None, result_uuid=None, backend_name=None, verified=False)

GitHub

Class representing an analysis result for an experiment.

AnalysisResult constructor.

Parameters

  • experiment_uuid (str) – Unique identifier of the experiment.
  • device_components (List[str]) – Device component types.
  • result_type (str) – Result type.
  • fit (Optional[Dict]) – Fit value.
  • chisq (Optional[float]) – chi^2 decimal value of the fit.
  • quality (Union[ResultQuality, str]) – Quality of the measurement value.
  • tags (Optional[List[str]]) – Tags for this result.
  • result_uuid (Optional[str]) – Unique identifier for the result.
  • backend_name (Optional[str]) – Name of the backend on which the experiment was run.
  • verified (Optional[bool]) – Indicates whether this result has been verified..

Raises

IBMQInputValueError – If an input argument is invalid.

__init__

__init__(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=<ResultQuality.UNKNOWN: 'No Information'>, tags=None, result_uuid=None, backend_name=None, verified=False)

AnalysisResult constructor.

Parameters

  • experiment_uuid (str) – Unique identifier of the experiment.
  • device_components (List[str]) – Device component types.
  • result_type (str) – Result type.
  • fit (Optional[Dict]) – Fit value.
  • chisq (Optional[float]) – chi^2 decimal value of the fit.
  • quality (Union[ResultQuality, str]) – Quality of the measurement value.
  • tags (Optional[List[str]]) – Tags for this result.
  • result_uuid (Optional[str]) – Unique identifier for the result.
  • backend_name (Optional[str]) – Name of the backend on which the experiment was run.
  • verified (Optional[bool]) – Indicates whether this result has been verified..

Raises

IBMQInputValueError – If an input argument is invalid.


Methods

__init__(experiment_uuid, device_components, …)AnalysisResult constructor.
from_remote_data(remote_data)Create an instance of this class from remote data.
update_from_remote_data(remote_data)Update the attributes of this instance using remote data.

Attributes

creation_datetimeReturn the timestamp when the experiment was created.
qualityReturn the analysis result quality.
updated_datetimeReturn the timestamp when the experiment was last updated.
uuidReturn UUID of this analysis result.

creation_datetime

Return the timestamp when the experiment was created.

Return type

datetime

from_remote_data

classmethod from_remote_data(remote_data)

Create an instance of this class from remote data.

Parameters

remote_data (Dict) – Remote data to use.

Return type

AnalysisResult

Returns

An instance of this class.

quality

Return the analysis result quality.

Return type

ResultQuality

update_from_remote_data

update_from_remote_data(remote_data)

Update the attributes of this instance using remote data.

Parameters

remote_data (Dict) – Remote data used to update this instance.

Return type

None

updated_datetime

Return the timestamp when the experiment was last updated.

Return type

datetime

uuid

Return UUID of this analysis result.

Return type

str

Was this page helpful?
Report a bug or request content on GitHub.