57 lines
1.7 KiB
Plaintext
57 lines
1.7 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
|
||
---
|
||
|
||
# QobjHeader
|
||
|
||
<Class id="qiskit.qobj.QobjHeader" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/qobj/common.py#L62-L65" signature="qiskit.qobj.QobjHeader(**kwargs)" modifiers="class">
|
||
Bases: `QobjDictField`
|
||
|
||
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.
|
||
|
||
## Methods
|
||
|
||
### from\_dict
|
||
|
||
<Function id="qiskit.qobj.QobjHeader.from_dict" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/qobj/common.py#L41-L53" signature="from_dict(data)" modifiers="classmethod">
|
||
Create a new QobjHeader object from a dictionary.
|
||
|
||
**Parameters**
|
||
|
||
**data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – 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" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/qobj/common.py#L33-L39" signature="to_dict()">
|
||
Return a dictionary format representation of the OpenQASM 2 Qobj.
|
||
|
||
**Returns**
|
||
|
||
The dictionary form of the QobjHeader.
|
||
|
||
**Return type**
|
||
|
||
[dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")
|
||
</Function>
|
||
</Class>
|
||
|