30 lines
1.3 KiB
Plaintext
30 lines
1.3 KiB
Plaintext
---
|
||
title: pad
|
||
description: API reference for qiskit.pulse.transforms.pad
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit.pulse.transforms.pad
|
||
---
|
||
|
||
# qiskit.pulse.transforms.pad
|
||
|
||
<Function id="qiskit.pulse.transforms.pad" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py" signature="pad(schedule, channels=None, until=None, inplace=False)">
|
||
Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`.
|
||
|
||
**Parameters**
|
||
|
||
* **schedule** ([`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")) – Schedule to pad.
|
||
* **channels** (`Optional`\[`Iterable`\[[`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added.
|
||
* **until** (`Optional`\[`int`]) – Time to pad until. Defaults to `schedule.duration` if not provided.
|
||
* **inplace** (`bool`) – Pad this schedule by mutating rather than returning a new schedule.
|
||
|
||
**Return type**
|
||
|
||
[`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")
|
||
|
||
**Returns**
|
||
|
||
The padded schedule.
|
||
</Function>
|
||
|