55 lines
2.0 KiB
Plaintext
55 lines
2.0 KiB
Plaintext
---
|
||
title: plot_bloch_multivector
|
||
description: API reference for qiskit.visualization.plot_bloch_multivector
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit.visualization.plot_bloch_multivector
|
||
---
|
||
|
||
# qiskit.visualization.plot\_bloch\_multivector
|
||
|
||
<Function id="qiskit.visualization.plot_bloch_multivector" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py" signature="plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)">
|
||
Plot the Bloch sphere.
|
||
|
||
Plot a sphere, axes, the Bloch vector, and its projections onto each axis.
|
||
|
||
**Parameters**
|
||
|
||
* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state.
|
||
* **title** (*str*) – a string that represents the plot title
|
||
* **figsize** (*tuple*) – Has no effect, here for compatibility only.
|
||
* **reverse\_bits** (*bool*) – If True, plots qubits following Qiskit’s convention \[Default:False].
|
||
|
||
**Returns**
|
||
|
||
A matplotlib figure instance.
|
||
|
||
**Return type**
|
||
|
||
matplotlib.Figure
|
||
|
||
**Raises**
|
||
|
||
* **MissingOptionalLibraryError** – Requires matplotlib.
|
||
* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state.
|
||
|
||
**Example**
|
||
|
||
```python
|
||
from qiskit import QuantumCircuit
|
||
from qiskit.quantum_info import Statevector
|
||
from qiskit.visualization import plot_bloch_multivector
|
||
%matplotlib inline
|
||
|
||
qc = QuantumCircuit(2)
|
||
qc.h(0)
|
||
qc.x(1)
|
||
|
||
state = Statevector.from_instruction(qc)
|
||
plot_bloch_multivector(state)
|
||
```
|
||
|
||
|
||
</Function>
|
||
|