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

62 lines
1.6 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: PulseLibraryItem (v0.31)
description: API reference for qiskit.qobj.PulseLibraryItem in qiskit v0.31
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.qobj.PulseLibraryItem
---
# PulseLibraryItem
<Class id="qiskit.qobj.PulseLibraryItem" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py" signature="PulseLibraryItem(name, samples)" modifiers="class">
Bases: `object`
An item in a pulse library.
Instantiate a pulse library item.
**Parameters**
* **name** (*str*) A name for the pulse.
* **samples** (*list\[complex]*) A list of complex values defining pulse shape.
## Methods
<span id="qiskit-qobj-pulselibraryitem-from-dict" />
### from\_dict
<Function id="qiskit.qobj.PulseLibraryItem.from_dict" signature="PulseLibraryItem.from_dict(data)" modifiers="classmethod">
Create a new PulseLibraryItem object from a dictionary.
**Parameters**
**data** (*dict*) A dictionary for the experiment config
**Returns**
The object from the input dictionary.
**Return type**
[PulseLibraryItem](qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem")
</Function>
<span id="qiskit-qobj-pulselibraryitem-to-dict" />
### to\_dict
<Function id="qiskit.qobj.PulseLibraryItem.to_dict" signature="PulseLibraryItem.to_dict()">
Return a dictionary format representation of the pulse library item.
**Returns**
The dictionary form of the PulseLibraryItem.
**Return type**
dict
</Function>
</Class>