73 lines
2.4 KiB
Plaintext
73 lines
2.4 KiB
Plaintext
---
|
||
title: AlignEquispaced
|
||
description: API reference for qiskit.pulse.transforms.AlignEquispaced
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.pulse.transforms.AlignEquispaced
|
||
---
|
||
|
||
# AlignEquispaced
|
||
|
||
<Class id="qiskit.pulse.transforms.AlignEquispaced" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py" signature="AlignEquispaced(duration)" modifiers="class">
|
||
Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind")
|
||
|
||
Align instructions with equispaced interval within a specified duration.
|
||
|
||
Instructions played on different channels are also arranged in a sequence. This alignment is convenient to create dynamical decoupling sequences such as PDD.
|
||
|
||
Create new equispaced context.
|
||
|
||
**Parameters**
|
||
|
||
**duration** (`Union`\[`int`, [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")]) – Duration of this context. This should be larger than the schedule duration. If the specified duration is shorter than the schedule duration, no alignment is performed and the input schedule is just returned. This duration can be parametrized.
|
||
|
||
## Methods
|
||
|
||
### align
|
||
|
||
<Function id="qiskit.pulse.transforms.AlignEquispaced.align" signature="AlignEquispaced.align(schedule)">
|
||
Reallocate instructions according to the policy.
|
||
|
||
Only top-level sub-schedules are aligned. If sub-schedules are nested, nested schedules are not recursively aligned.
|
||
|
||
**Parameters**
|
||
|
||
**schedule** ([`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")) – Schedule to align.
|
||
|
||
**Return type**
|
||
|
||
[`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")
|
||
|
||
**Returns**
|
||
|
||
Schedule with reallocated instructions.
|
||
</Function>
|
||
|
||
### to\_dict
|
||
|
||
<Function id="qiskit.pulse.transforms.AlignEquispaced.to_dict" signature="AlignEquispaced.to_dict()">
|
||
Returns dictionary to represent this alignment.
|
||
|
||
**Return type**
|
||
|
||
`Dict`\[`str`, `Any`]
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.pulse.transforms.AlignEquispaced.duration">
|
||
Return context duration.
|
||
</Attribute>
|
||
|
||
### is\_sequential
|
||
|
||
<Attribute id="qiskit.pulse.transforms.AlignEquispaced.is_sequential">
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Attribute>
|
||
</Class>
|
||
|