Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

channels

This module defines Pulse Channels. Channels include:

  • transmit channels, which should subclass PulseChannel
  • receive channels, such as AcquireChannel
  • non-signal “channels” such as SnapshotChannel, MemorySlot and RegisterChannel.

Novel channel types can often utilize the ControlChannel, but if this is not sufficient, new channel types can be created. Then, they must be supported in the PulseQobj schema and the assembler.

Classes

AcquireChannel(index)Acquire channels are used to collect data.
Channel(index)Base class of channels.
ControlChannel(index)Control channels provide supplementary control over the qubit to the drive channel.
DriveChannel(index)Drive channels transmit signals to qubits which enact gate operations.
MeasureChannel(index)Measure channels transmit measurement stimulus pulses for readout.
MemorySlot(index)Memory slot channels represent classical memory storage.
PulseChannel(index)Base class of transmit Channels.
RegisterSlot(index)Classical resister slot channels represent classical registers (low-latency classical memory).
SnapshotChannel()Snapshot channels are used to specify commands for simulators.

AcquireChannel(index) GitHub(opens in a new tab)

Acquire channels are used to collect data.

Channel class.

Parameters

index (int) – Index of channel.

Raises

PulseError – If index is not a nonnegative integer.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

Channel(index) GitHub(opens in a new tab)

Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, DriveChannel(0) holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0.

Channel class.

Parameters

index (int) – Index of channel.

Raises

PulseError – If index is not a nonnegative integer.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

prefix

= None

A shorthand string prefix for characterizing the channel type.

ControlChannel(index) GitHub(opens in a new tab)

Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index.

Channel class.

Parameters

index (int) – Index of channel.

Raises

PulseError – If index is not a nonnegative integer.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

DriveChannel(index) GitHub(opens in a new tab)

Drive channels transmit signals to qubits which enact gate operations.

Channel class.

Parameters

index (int) – Index of channel.

Raises

PulseError – If index is not a nonnegative integer.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

MeasureChannel(index) GitHub(opens in a new tab)

Measure channels transmit measurement stimulus pulses for readout.

Channel class.

Parameters

index (int) – Index of channel.

Raises

PulseError – If index is not a nonnegative integer.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

MemorySlot(index) GitHub(opens in a new tab)

Memory slot channels represent classical memory storage.

Channel class.

Parameters

index (int) – Index of channel.

Raises

PulseError – If index is not a nonnegative integer.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

PulseChannel(index) GitHub(opens in a new tab)

Base class of transmit Channels. Pulses can be played on these channels.

Channel class.

Parameters

index (int) – Index of channel.

Raises

PulseError – If index is not a nonnegative integer.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

RegisterSlot(index) GitHub(opens in a new tab)

Classical resister slot channels represent classical registers (low-latency classical memory).

Channel class.

Parameters

index (int) – Index of channel.

Raises

PulseError – If index is not a nonnegative integer.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

SnapshotChannel GitHub(opens in a new tab)

Snapshot channels are used to specify commands for simulators.

Create new snapshot channel.

int

Return the index of this channel. The index is a label for a control signal line typically mapped trivially to a qubit index. For instance, DriveChannel(0) labels the signal line driving the qubit labeled with index 0.

Return type

int

str

Return the shorthand alias for this channel, which is based on its type and index.

Return type

str

Was this page helpful?