73 lines
2.1 KiB
Plaintext
73 lines
2.1 KiB
Plaintext
---
|
||
title: ControlChannel
|
||
description: API reference for qiskit.pulse.channels.ControlChannel
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.pulse.channels.ControlChannel
|
||
---
|
||
|
||
# ControlChannel
|
||
|
||
<Class id="qiskit.pulse.channels.ControlChannel" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py" signature="ControlChannel(index)" modifiers="class">
|
||
Bases: `qiskit.pulse.channels.PulseChannel`
|
||
|
||
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.
|
||
|
||
## Methods
|
||
|
||
### is\_parameterized
|
||
|
||
<Function id="qiskit.pulse.channels.ControlChannel.is_parameterized" signature="ControlChannel.is_parameterized()">
|
||
Return True iff the channel is parameterized.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### index
|
||
|
||
<Attribute id="qiskit.pulse.channels.ControlChannel.index">
|
||
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**
|
||
|
||
`Union`\[`int`, [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")]
|
||
</Attribute>
|
||
|
||
### name
|
||
|
||
<Attribute id="qiskit.pulse.channels.ControlChannel.name">
|
||
Return the shorthand alias for this channel, which is based on its type and index.
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit.pulse.channels.ControlChannel.parameters">
|
||
Parameters which determine the channel index.
|
||
|
||
**Return type**
|
||
|
||
`Set`
|
||
</Attribute>
|
||
|
||
### prefix
|
||
|
||
<Attribute id="qiskit.pulse.channels.ControlChannel.prefix" attributeTypeHint="Optional[str]" attributeValue="'u'">
|
||
A shorthand string prefix for characterizing the channel type.
|
||
</Attribute>
|
||
</Class>
|
||
|