71 lines
2.4 KiB
Plaintext
71 lines
2.4 KiB
Plaintext
---
|
||
title: QobjHeader
|
||
description: API reference for qiskit.qobj.QobjHeader
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.qobj.QobjHeader
|
||
---
|
||
|
||
# qiskit.qobj.QobjHeader
|
||
|
||
<Class id="qiskit.qobj.QobjHeader" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py" signature="QobjHeader(**kwargs)" modifiers="class">
|
||
A class used to represent a dictionary header in Qobj objects.
|
||
|
||
Instantiate a new Qobj dict field object.
|
||
|
||
**Parameters**
|
||
|
||
**kwargs** – arbitrary keyword arguments that can be accessed as attributes of the object.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.qobj.QobjHeader.__init__" signature="__init__(**kwargs)">
|
||
Instantiate a new Qobj dict field object.
|
||
|
||
**Parameters**
|
||
|
||
**kwargs** – arbitrary keyword arguments that can be accessed as attributes of the object.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.qobj.QobjHeader.__init__ "qiskit.qobj.QobjHeader.__init__")(\*\*kwargs) | Instantiate a new Qobj dict field object. |
|
||
| [`from_dict`](#qiskit.qobj.QobjHeader.from_dict "qiskit.qobj.QobjHeader.from_dict")(data) | Create a new QobjHeader object from a dictionary. |
|
||
| [`to_dict`](#qiskit.qobj.QobjHeader.to_dict "qiskit.qobj.QobjHeader.to_dict")() | Return a dictionary format representation of the QASM Qobj. |
|
||
|
||
### from\_dict
|
||
|
||
<Function id="qiskit.qobj.QobjHeader.from_dict" signature="from_dict(data)" modifiers="classmethod">
|
||
Create a new QobjHeader object from a dictionary.
|
||
|
||
**Parameters**
|
||
|
||
**data** (*dict*) – A dictionary representing the QobjHeader to create. It will be in the same format as output by [`to_dict()`](#qiskit.qobj.QobjHeader.to_dict "qiskit.qobj.QobjHeader.to_dict").
|
||
|
||
**Returns**
|
||
|
||
The QobjDictField from the input dictionary.
|
||
|
||
**Return type**
|
||
|
||
QobjDictFieldr
|
||
</Function>
|
||
|
||
### to\_dict
|
||
|
||
<Function id="qiskit.qobj.QobjHeader.to_dict" signature="to_dict()">
|
||
Return a dictionary format representation of the QASM Qobj.
|
||
|
||
**Returns**
|
||
|
||
The dictionary form of the QobjHeader.
|
||
|
||
**Return type**
|
||
|
||
dict
|
||
</Function>
|
||
</Class>
|
||
|