67 lines
1.8 KiB
Plaintext
67 lines
1.8 KiB
Plaintext
---
|
|
title: SnapshotChannel
|
|
description: API reference for qiskit.pulse.channels.SnapshotChannel
|
|
in_page_toc_min_heading_level: 1
|
|
python_api_type: class
|
|
python_api_name: qiskit.pulse.channels.SnapshotChannel
|
|
---
|
|
|
|
# SnapshotChannel
|
|
|
|
<Class id="qiskit.pulse.channels.SnapshotChannel" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py" signature="SnapshotChannel(*args, **kwargs)" modifiers="class">
|
|
Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")
|
|
|
|
Snapshot channels are used to specify instructions for simulators.
|
|
|
|
Create new snapshot channel.
|
|
|
|
## Methods
|
|
|
|
### is\_parameterized
|
|
|
|
<Function id="qiskit.pulse.channels.SnapshotChannel.is_parameterized" signature="SnapshotChannel.is_parameterized()">
|
|
Return True iff the channel is parameterized.
|
|
|
|
**Return type**
|
|
|
|
`bool`
|
|
</Function>
|
|
|
|
## Attributes
|
|
|
|
### index
|
|
|
|
<Attribute id="qiskit.pulse.channels.SnapshotChannel.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`]
|
|
</Attribute>
|
|
|
|
### name
|
|
|
|
<Attribute id="qiskit.pulse.channels.SnapshotChannel.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.SnapshotChannel.parameters">
|
|
Parameters which determine the channel index.
|
|
|
|
**Return type**
|
|
|
|
`Set`
|
|
</Attribute>
|
|
|
|
### prefix
|
|
|
|
<Attribute id="qiskit.pulse.channels.SnapshotChannel.prefix" attributeValue="'s'" />
|
|
</Class>
|
|
|