qiskit-documentation/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.mdx

79 lines
2.7 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: QasmQobj
description: API reference for qiskit.qobj.QasmQobj
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.qobj.QasmQobj
---
# QasmQobj
<Class id="qiskit.qobj.QasmQobj" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py" signature="QasmQobj(qobj_id=None, config=None, experiments=None, header=None)" modifiers="class">
Bases: `object`
A QASM Qobj.
Instantiate a new QASM Qobj Object.
Each QASM Qobj object is used to represent a single payload that will be passed to a Qiskit provider. It mirrors the Qobj the published [Qobj specification](https://arxiv.org/abs/1809.03452) for OpenQASM experiments.
**Parameters**
* **qobj\_id** (*str*) An identifier for the qobj
* **config** (*QasmQobjRunConfig*) A config for the entire run
* **header** ([*QobjHeader*](qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader")) A header for the entire run
* **experiments** (*list*) A list of lists of [`QasmQobjExperiment`](qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment") objects representing an experiment
## Methods
### from\_dict
<Function id="qiskit.qobj.QasmQobj.from_dict" signature="QasmQobj.from_dict(data)" modifiers="classmethod">
Create a new QASMQobj object from a dictionary.
**Parameters**
**data** (*dict*) A dictionary representing the QasmQobj to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.QasmQobj#to_dict "qiskit.qobj.QasmQobj.to_dict").
**Returns**
The QasmQobj from the input dictionary.
**Return type**
[QasmQobj](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")
</Function>
### to\_dict
<Function id="qiskit.qobj.QasmQobj.to_dict" signature="QasmQobj.to_dict()">
Return a dictionary format representation of the QASM Qobj.
Note this dict is not in the json wire format expected by IBMQ and qobj specification because complex numbers are still of type complex. Also this may contain native numpy arrays. When serializing this output for use with IBMQ you can leverage a json encoder that converts these as expected. For example:
```python
import json
import numpy
class QobjEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, numpy.ndarray):
return obj.tolist()
if isinstance(obj, complex):
return (obj.real, obj.imag)
return json.JSONEncoder.default(self, obj)
json.dumps(qobj.to_dict(), cls=QobjEncoder)
```
**Returns**
A dictionary representation of the QasmQobj object
**Return type**
dict
</Function>
</Class>