qiskit-documentation/docs/api/qiskit/0.29/qiskit.pulse.library.discre...

37 lines
3.4 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: discrete (v0.29)
description: API reference for qiskit.pulse.library.discrete in qiskit v0.29
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit.pulse.library.discrete
---
<span id="module-qiskit.pulse.library.discrete" />
<span id="qiskit-pulse-library-discrete" />
# qiskit.pulse.library.discrete
Module for builtin discrete pulses.
Note the sampling strategy use for all discrete pulses is `midpoint`.
**Functions**
| | |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `constant`(duration, amp\[, name]) | Generates constant-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `cos`(duration, amp\[, freq, phase, name]) | Generates cosine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `drag`(duration, amp, sigma, beta\[, name, …]) | Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform") for standard nonlinear oscillator (SNO) \[1]. |
| `gaussian`(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized gaussian [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `gaussian_deriv`(duration, amp, sigma\[, name]) | Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `gaussian_square`(duration, amp, sigma\[, …]) | Generates gaussian square [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `sawtooth`(duration, amp\[, freq, phase, name]) | Generates sawtooth wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `sech`(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized sech [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `sech_deriv`(duration, amp, sigma\[, name]) | Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `sin`(duration, amp\[, freq, phase, name]) | Generates sine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |
| `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). |