58 lines
1.4 KiB
Plaintext
58 lines
1.4 KiB
Plaintext
---
|
||
title: PulseLibraryItem
|
||
description: API reference for qiskit.qobj.PulseLibraryItem
|
||
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.20/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
|
||
|
||
### 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>
|
||
|
||
### 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>
|
||
|