Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK. Go to the latest version

AlignFunc

class AlignFunc(duration, func)

GitHub

Bases: qiskit.pulse.transforms.alignments.AlignmentKind

Allocate instructions at position specified by callback function.

The position is specified for each instruction of index j as a fractional coordinate in [0, 1] within the specified duration.

Instructions played on different channels are also arranged in a sequence. This alignment is convenient to create dynamical decoupling sequences such as UDD.

For example, UDD sequence with 10 pulses can be specified with following function.

def udd10_pos(j):
return np.sin(np.pi*j/(2*10 + 2))**2
Note

This context cannot be QPY serialized because of the callable. If you use this context, your program cannot be saved in QPY format.

Create new equispaced context.

Parameters

  • duration (Union[int, 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.
  • func (Callable) – A function that takes an index of sub-schedule and returns the fractional coordinate of of that sub-schedule. The returned value should be defined within [0, 1]. The pulse index starts from 1.

Methods

align

AlignFunc.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) – Schedule to align.

Return type

Schedule

Returns

Schedule with reallocated instructions.

to_dict

AlignFunc.to_dict()

Returns dictionary to represent this alignment.

Note

func is not presented in this dictionary. Just name.

Return type

Dict[str, Any]


Attributes

duration

Return context duration.

func

Return context alignment function.

is_sequential

Return type

bool

Was this page helpful?
Report a bug or request content on GitHub.