144 lines
6.8 KiB
Plaintext
144 lines
6.8 KiB
Plaintext
---
|
||
title: AnalysisResult
|
||
description: API reference for qiskit.providers.ibmq.experiment.AnalysisResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult
|
||
---
|
||
|
||
# qiskit.providers.ibmq.experiment.AnalysisResult
|
||
|
||
<Class id="qiskit.providers.ibmq.experiment.AnalysisResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/analysis_result.py" signature="AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=<ResultQuality.NO_INFORMATION: 'No Information'>, tags=None, result_uuid=None, backend_name=None)" modifiers="class">
|
||
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.
|
||
|
||
**Raises**
|
||
|
||
**IBMQInputValueError** – If an input argument is invalid.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.providers.ibmq.experiment.AnalysisResult.__init__" signature="__init__(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=<ResultQuality.NO_INFORMATION: 'No Information'>, tags=None, result_uuid=None, backend_name=None)">
|
||
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.
|
||
|
||
**Raises**
|
||
|
||
**IBMQInputValueError** – If an input argument is invalid.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.providers.ibmq.experiment.AnalysisResult.__init__ "qiskit.providers.ibmq.experiment.AnalysisResult.__init__")(experiment\_uuid, device\_components, …) | AnalysisResult constructor. |
|
||
| [`from_remote_data`](#qiskit.providers.ibmq.experiment.AnalysisResult.from_remote_data "qiskit.providers.ibmq.experiment.AnalysisResult.from_remote_data")(remote\_data) | Create an instance of this class from remote data. |
|
||
| [`update_from_remote_data`](#qiskit.providers.ibmq.experiment.AnalysisResult.update_from_remote_data "qiskit.providers.ibmq.experiment.AnalysisResult.update_from_remote_data")(remote\_data) | Update the attributes of this instance using remote data. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
||
| [`creation_datetime`](#qiskit.providers.ibmq.experiment.AnalysisResult.creation_datetime "qiskit.providers.ibmq.experiment.AnalysisResult.creation_datetime") | Return the timestamp when the experiment was created. |
|
||
| [`quality`](#qiskit.providers.ibmq.experiment.AnalysisResult.quality "qiskit.providers.ibmq.experiment.AnalysisResult.quality") | Return the analysis result quality. |
|
||
| [`updated_datetime`](#qiskit.providers.ibmq.experiment.AnalysisResult.updated_datetime "qiskit.providers.ibmq.experiment.AnalysisResult.updated_datetime") | Return the timestamp when the experiment was last updated. |
|
||
| [`uuid`](#qiskit.providers.ibmq.experiment.AnalysisResult.uuid "qiskit.providers.ibmq.experiment.AnalysisResult.uuid") | Return UUID of this analysis result. |
|
||
|
||
### creation\_datetime
|
||
|
||
<Attribute id="qiskit.providers.ibmq.experiment.AnalysisResult.creation_datetime">
|
||
Return the timestamp when the experiment was created.
|
||
|
||
**Return type**
|
||
|
||
`datetime`
|
||
</Attribute>
|
||
|
||
### from\_remote\_data
|
||
|
||
<Function id="qiskit.providers.ibmq.experiment.AnalysisResult.from_remote_data" signature="from_remote_data(remote_data)" modifiers="classmethod">
|
||
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.
|
||
</Function>
|
||
|
||
### quality
|
||
|
||
<Attribute id="qiskit.providers.ibmq.experiment.AnalysisResult.quality">
|
||
Return the analysis result quality.
|
||
|
||
**Return type**
|
||
|
||
`ResultQuality`
|
||
</Attribute>
|
||
|
||
### update\_from\_remote\_data
|
||
|
||
<Function id="qiskit.providers.ibmq.experiment.AnalysisResult.update_from_remote_data" signature="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`
|
||
</Function>
|
||
|
||
### updated\_datetime
|
||
|
||
<Attribute id="qiskit.providers.ibmq.experiment.AnalysisResult.updated_datetime">
|
||
Return the timestamp when the experiment was last updated.
|
||
|
||
**Return type**
|
||
|
||
`datetime`
|
||
</Attribute>
|
||
|
||
### uuid
|
||
|
||
<Attribute id="qiskit.providers.ibmq.experiment.AnalysisResult.uuid">
|
||
Return UUID of this analysis result.
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
</Class>
|
||
|