qiskit.providers.ibmq.experiment.AnalysisResult¶

class AnalysisResult(experiment_uuid, device_components, fit, result_type, chisq=None, quality=<ResultQuality.NO_INFORMATION: 'No Information'>, tags=None, result_uuid=None, backend_name=None)[source]¶

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.
fit (Union[Fit, Dict[str, float]]) – Fit value. This can be an instance of the Fit class, or a dictionary with the keys value and optionally variance.
result_type (str) – Result type.
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.

Raises

IBMQInputValueError – If an input argument is invalid.

__init__(experiment_uuid, device_components, fit, result_type, chisq=None, quality=<ResultQuality.NO_INFORMATION: 'No Information'>, tags=None, result_uuid=None, backend_name=None)[source]¶

AnalysisResult constructor.

Parameters

experiment_uuid (str) – Unique identifier of the experiment.
device_components (List[str]) – Device component types.
fit (Union[Fit, Dict[str, float]]) – Fit value. This can be an instance of the Fit class, or a dictionary with the keys value and optionally variance.
result_type (str) – Result type.
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.

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_datetime`	Return the timestamp when the experiment was created.
`fit`	Return the fit value for the experiment.
`quality`	Return the analysis result quality.
`updated_datetime`	Return the timestamp when the experiment was last updated.
`uuid`	Return UUID of this analysis result.

property creation_datetime¶

Return the timestamp when the experiment was created.

Return type: datetime

property fit¶

Return the fit value for the experiment.

Return type: Fit

classmethod from_remote_data(remote_data)[source]¶

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.

property quality¶

Return the analysis result quality.

Return type: ResultQuality

update_from_remote_data(remote_data)[source]¶

Update the attributes of this instance using remote data.

Parameters: remote_data (Dict) – Remote data used to update this instance.
Return type: None

property updated_datetime¶

Return the timestamp when the experiment was last updated.

Return type: datetime

property uuid¶

Return UUID of this analysis result.

Return type: str