Skip to main contentIBM Quantum Documentation

qiskit.visualization.plot_state_qsphere

qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)GitHub(opens in a new tab)

Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase.

Parameters

  • state (Statevector orDensityMatrix or ndarray) – an N-qubit quantum state.
  • figsize (tuple(opens in a new tab)) – Figure size in inches.
  • ax (matplotlib.axes.Axes(opens in a new tab)) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant.
  • show_state_labels (bool(opens in a new tab)) – An optional boolean indicating whether to show labels for each basis state.
  • show_state_phases (bool(opens in a new tab)) – An optional boolean indicating whether to show the phase for each basis state.
  • use_degrees (bool(opens in a new tab)) – An optional boolean indicating whether to use radians or degrees for the phase values in the plot.

Returns

A matplotlib figure instance if the ax kwarg is not set

Return type

matplotlib.figure.Figure(opens in a new tab)

Raises

Examples

from qiskit import QuantumCircuit
from qiskit.quantum_info import Statevector
from qiskit.visualization import plot_state_qsphere
 
qc = QuantumCircuit(2)
qc.h(0)
qc.cx(0, 1)
 
state = Statevector(qc)
plot_state_qsphere(state)
../_images/qiskit-visualization-plot_state_qsphere-1.png
# You can show the phase of each state and use
# degrees instead of radians
 
from qiskit.quantum_info import DensityMatrix
import numpy as np
from qiskit import QuantumCircuit
from qiskit.visualization import plot_state_qsphere
 
qc = QuantumCircuit(2)
qc.h([0, 1])
qc.cz(0,1)
qc.ry(np.pi/3, 0)
qc.rx(np.pi/5, 1)
qc.z(1)
 
matrix = DensityMatrix(qc)
plot_state_qsphere(matrix,
     show_state_phases = True, use_degrees = True)
../_images/qiskit-visualization-plot_state_qsphere-2.png
Was this page helpful?