qiskit-documentation/docs/api/qiskit/0.42/qiskit.pulse.channels.Drive...

73 lines
1.9 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: DriveChannel
description: API reference for qiskit.pulse.channels.DriveChannel
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.pulse.channels.DriveChannel
---
# DriveChannel
<Class id="qiskit.pulse.channels.DriveChannel" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py" signature="DriveChannel(index)" modifiers="class">
Bases: `qiskit.pulse.channels.PulseChannel`
Drive channels transmit signals to qubits which enact gate operations.
Channel class.
**Parameters**
**index** (`int`) Index of channel.
## Methods
### is\_parameterized
<Function id="qiskit.pulse.channels.DriveChannel.is_parameterized" signature="DriveChannel.is_parameterized()">
Return True iff the channel is parameterized.
**Return type**
`bool`
</Function>
## Attributes
### index
<Attribute id="qiskit.pulse.channels.DriveChannel.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.DriveChannel.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.DriveChannel.parameters">
Parameters which determine the channel index.
**Return type**
`Set`
</Attribute>
### prefix
<Attribute id="qiskit.pulse.channels.DriveChannel.prefix" attributeTypeHint="Optional[str]" attributeValue="'d'">
A shorthand string prefix for characterizing the channel type.
</Attribute>
</Class>