qiskit-documentation/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperi...

65 lines
2.0 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: PulseQobjExperiment (v0.31)
description: API reference for qiskit.qobj.PulseQobjExperiment in qiskit v0.31
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.qobj.PulseQobjExperiment
---
# PulseQobjExperiment
<Class id="qiskit.qobj.PulseQobjExperiment" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py" signature="PulseQobjExperiment(instructions, config=None, header=None)" modifiers="class">
Bases: `object`
A Pulse Qobj Experiment.
Each instance of this class is used to represent an individual Pulse experiment as part of a larger Pulse Qobj.
Instantiate a PulseQobjExperiment.
**Parameters**
* **config** ([*PulseQobjExperimentConfig*](qiskit.qobj.PulseQobjExperimentConfig "qiskit.qobj.PulseQobjExperimentConfig")) A config object for the experiment
* **header** (*PulseQobjExperimentHeader*) A header object for the experiment
* **instructions** (*list*) A list of [`PulseQobjInstruction`](qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction") objects
## Methods
<span id="qiskit-qobj-pulseqobjexperiment-from-dict" />
### from\_dict
<Function id="qiskit.qobj.PulseQobjExperiment.from_dict" signature="PulseQobjExperiment.from_dict(data)" modifiers="classmethod">
Create a new PulseQobjExperiment object from a dictionary.
**Parameters**
**data** (*dict*) A dictionary for the experiment config
**Returns**
The object from the input dictionary.
**Return type**
[PulseQobjExperiment](qiskit.qobj.PulseQobjExperiment "qiskit.qobj.PulseQobjExperiment")
</Function>
<span id="qiskit-qobj-pulseqobjexperiment-to-dict" />
### to\_dict
<Function id="qiskit.qobj.PulseQobjExperiment.to_dict" signature="PulseQobjExperiment.to_dict()">
Return a dictionary format representation of the Experiment.
**Returns**
The dictionary form of the PulseQobjExperiment.
**Return type**
dict
</Function>
</Class>