-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
bloch.py
737 lines (675 loc) · 28.3 KB
/
bloch.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
# This code is part of Qiskit.
#
# (C) Copyright IBM 2017.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.
# This file is part of QuTiP: Quantum Toolbox in Python.
#
# Copyright (c) 2011 and later, Paul D. Nation and Robert J. Johansson.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the QuTiP: Quantum Toolbox in Python nor the names
# of its contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
###############################################################################
"""Bloch sphere"""
__all__ = ["Bloch"]
import os
import numpy as np
import matplotlib
import matplotlib.pyplot as plt
from matplotlib.patches import FancyArrowPatch
from mpl_toolkits.mplot3d import Axes3D, proj3d
from mpl_toolkits.mplot3d.art3d import Patch3D
from .utils import matplotlib_close_if_inline
class Arrow3D(Patch3D, FancyArrowPatch):
"""Makes a fancy arrow"""
# Nasty hack around a poorly implemented deprecation warning in Matplotlib 3.5 that issues two
# deprecation warnings if an artist's module does not claim to be part of the below module.
# This revolves around the method `Patch3D.do_3d_projection(self, renderer=None)`. The
# `renderer` argument has been deprecated since Matplotlib 3.4, but in 3.5 some internal calls
# during `Axes3D` display started calling the method. If an artist does not have this module,
# then it issues a deprecation warning, and calls it by passing the `renderer` parameter as
# well, which consequently triggers another deprecation warning. We should be able to remove
# this once 3.6 is the minimum supported version, because the deprecation period ends then.
__module__ = "mpl_toolkits.mplot3d.art3d"
def __init__(self, xs, ys, zs, zdir="z", **kwargs):
# The Patch3D.__init__() method just calls its own super() method and then
# self.set_3d_properties, but its __init__ signature is actually pretty incompatible with
# how it goes on to call set_3d_properties, so we just have to do things ourselves. The
# parent of Patch3D is Patch, which is also a parent of FancyArrowPatch, so its __init__ is
# still getting suitably called.
# pylint: disable=super-init-not-called
FancyArrowPatch.__init__(self, (0, 0), (0, 0), **kwargs)
self.set_3d_properties(tuple(zip(xs, ys)), zs, zdir)
self._path2d = None
def draw(self, renderer):
xs3d, ys3d, zs3d = zip(*self._segment3d)
x_s, y_s, _ = proj3d.proj_transform(xs3d, ys3d, zs3d, self.axes.M)
self._path2d = matplotlib.path.Path(np.column_stack([x_s, y_s]))
self.set_positions((x_s[0], y_s[0]), (x_s[1], y_s[1]))
FancyArrowPatch.draw(self, renderer)
class Bloch:
"""Class for plotting data on the Bloch sphere. Valid data can be
either points, vectors, or qobj objects.
Attributes:
axes (instance):
User supplied Matplotlib axes for Bloch sphere animation.
fig (instance):
User supplied Matplotlib Figure instance for plotting Bloch sphere.
font_color (str):
Color of font used for Bloch sphere labels.
font_size (int):
Size of font used for Bloch sphere labels.
frame_alpha (float):
Sets transparency of Bloch sphere frame.
frame_color (str):
Color of sphere wireframe.
frame_width (int):
Width of wireframe.
point_color (list):
List of colors for Bloch sphere point markers to cycle through.
i.e. By default, points 0 and 4 will both be blue ('b').
point_marker (list):
List of point marker shapes to cycle through.
point_size (list):
List of point marker sizes. Note, not all point markers look
the same size when plotted!
sphere_alpha (float):
Transparency of Bloch sphere itself.
sphere_color (str):
Color of Bloch sphere.
figsize (list):
Figure size of Bloch sphere plot. Best to have both numbers the same;
otherwise you will have a Bloch sphere that looks like a football.
vector_color (list):
List of vector colors to cycle through.
vector_width (int):
Width of displayed vectors.
vector_style (str):
Vector arrowhead style (from matplotlib's arrow style).
vector_mutation (int):
Width of vectors arrowhead.
view (list):
Azimuthal and Elevation viewing angles.
xlabel (list):
List of strings corresponding to +x and -x axes labels, respectively.
xlpos (list):
Positions of +x and -x labels respectively.
ylabel (list):
List of strings corresponding to +y and -y axes labels, respectively.
ylpos (list):
Positions of +y and -y labels respectively.
zlabel (list):
List of strings corresponding to +z and -z axes labels, respectively.
zlpos (list):
Positions of +z and -z labels respectively.
"""
def __init__(self, fig=None, axes=None, view=None, figsize=None, background=False):
# Figure and axes
self._ext_fig = False
if fig is not None:
self._ext_fig = True
self.fig = fig
self._ext_axes = False
if axes is not None:
self._ext_fig = True
self._ext_axes = True
self.axes = axes
# Background axes, default = False
self.background = background
# The size of the figure in inches, default = [5,5].
self.figsize = figsize if figsize else [5, 5]
# Azimuthal and Elevation viewing angles, default = [-60,30].
self.view = view if view else [-60, 30]
# Color of Bloch sphere, default = #FFDDDD
self.sphere_color = "#FFDDDD"
# Transparency of Bloch sphere, default = 0.2
self.sphere_alpha = 0.2
# Color of wireframe, default = 'gray'
self.frame_color = "gray"
# Width of wireframe, default = 1
self.frame_width = 1
# Transparency of wireframe, default = 0.2
self.frame_alpha = 0.2
# Labels for x-axis (in LaTex), default = ['$x$', '']
self.xlabel = ["$x$", ""]
# Position of x-axis labels, default = [1.2, -1.2]
self.xlpos = [1.2, -1.2]
# Labels for y-axis (in LaTex), default = ['$y$', '']
self.ylabel = ["$y$", ""]
# Position of y-axis labels, default = [1.1, -1.1]
self.ylpos = [1.2, -1.2]
# Labels for z-axis (in LaTex),
# default = [r'$\left|1\right>$', r'$\left|0\right>$']
self.zlabel = [r"$\left|0\right>$", r"$\left|1\right>$"]
# Position of z-axis labels, default = [1.2, -1.2]
self.zlpos = [1.2, -1.2]
# ---font options---
# Color of fonts, default = 'black'
self.font_color = plt.rcParams["axes.labelcolor"]
# Size of fonts, default = 20
self.font_size = 20
# ---vector options---
# List of colors for Bloch vectors, default = ['b','g','r','y']
self.vector_color = ["#dc267f", "#648fff", "#fe6100", "#785ef0", "#ffb000"]
#: Width of Bloch vectors, default = 5
self.vector_width = 5
#: Style of Bloch vectors, default = '-|>' (or 'simple')
self.vector_style = "-|>"
#: Sets the width of the vectors arrowhead
self.vector_mutation = 20
# ---point options---
# List of colors for Bloch point markers, default = ['b','g','r','y']
self.point_color = ["b", "r", "g", "#CC6600"]
# Size of point markers, default = 25
self.point_size = [25, 32, 35, 45]
# Shape of point markers, default = ['o','^','d','s']
self.point_marker = ["o", "s", "d", "^"]
# ---data lists---
# Data for point markers
self.points = []
# Data for Bloch vectors
self.vectors = []
# Data for annotations
self.annotations = []
# Number of times sphere has been saved
self.savenum = 0
# Style of points, 'm' for multiple colors, 's' for single color
self.point_style = []
# status of rendering
self._rendered = False
def set_label_convention(self, convention):
"""Set x, y and z labels according to one of conventions.
Args:
convention (str):
One of the following:
- "original"
- "xyz"
- "sx sy sz"
- "01"
- "polarization jones"
- "polarization jones letters"
see also: http://en.wikipedia.org/wiki/Jones_calculus
- "polarization stokes"
see also: http://en.wikipedia.org/wiki/Stokes_parameters
Raises:
Exception: If convention is not valid.
"""
ketex = "$\\left.|%s\\right\\rangle$"
# \left.| is on purpose, so that every ket has the same size
if convention == "original":
self.xlabel = ["$x$", ""]
self.ylabel = ["$y$", ""]
self.zlabel = ["$\\left|0\\right>$", "$\\left|1\\right>$"]
elif convention == "xyz":
self.xlabel = ["$x$", ""]
self.ylabel = ["$y$", ""]
self.zlabel = ["$z$", ""]
elif convention == "sx sy sz":
self.xlabel = ["$s_x$", ""]
self.ylabel = ["$s_y$", ""]
self.zlabel = ["$s_z$", ""]
elif convention == "01":
self.xlabel = ["", ""]
self.ylabel = ["", ""]
self.zlabel = ["$\\left|0\\right>$", "$\\left|1\\right>$"]
elif convention == "polarization jones":
self.xlabel = [
ketex % "\\nearrow\\hspace{-1.46}\\swarrow",
ketex % "\\nwarrow\\hspace{-1.46}\\searrow",
]
self.ylabel = [ketex % "\\circlearrowleft", ketex % "\\circlearrowright"]
self.zlabel = [ketex % "\\leftrightarrow", ketex % "\\updownarrow"]
elif convention == "polarization jones letters":
self.xlabel = [ketex % "D", ketex % "A"]
self.ylabel = [ketex % "L", ketex % "R"]
self.zlabel = [ketex % "H", ketex % "V"]
elif convention == "polarization stokes":
self.ylabel = [
"$\\nearrow\\hspace{-1.46}\\swarrow$",
"$\\nwarrow\\hspace{-1.46}\\searrow$",
]
self.zlabel = ["$\\circlearrowleft$", "$\\circlearrowright$"]
self.xlabel = ["$\\leftrightarrow$", "$\\updownarrow$"]
else:
raise Exception("No such convention.")
def __str__(self):
string = ""
string += "Bloch data:\n"
string += "-----------\n"
string += "Number of points: " + str(len(self.points)) + "\n"
string += "Number of vectors: " + str(len(self.vectors)) + "\n"
string += "\n"
string += "Bloch sphere properties:\n"
string += "------------------------\n"
string += "font_color: " + str(self.font_color) + "\n"
string += "font_size: " + str(self.font_size) + "\n"
string += "frame_alpha: " + str(self.frame_alpha) + "\n"
string += "frame_color: " + str(self.frame_color) + "\n"
string += "frame_width: " + str(self.frame_width) + "\n"
string += "point_color: " + str(self.point_color) + "\n"
string += "point_marker: " + str(self.point_marker) + "\n"
string += "point_size: " + str(self.point_size) + "\n"
string += "sphere_alpha: " + str(self.sphere_alpha) + "\n"
string += "sphere_color: " + str(self.sphere_color) + "\n"
string += "figsize: " + str(self.figsize) + "\n"
string += "vector_color: " + str(self.vector_color) + "\n"
string += "vector_width: " + str(self.vector_width) + "\n"
string += "vector_style: " + str(self.vector_style) + "\n"
string += "vector_mutation: " + str(self.vector_mutation) + "\n"
string += "view: " + str(self.view) + "\n"
string += "xlabel: " + str(self.xlabel) + "\n"
string += "xlpos: " + str(self.xlpos) + "\n"
string += "ylabel: " + str(self.ylabel) + "\n"
string += "ylpos: " + str(self.ylpos) + "\n"
string += "zlabel: " + str(self.zlabel) + "\n"
string += "zlpos: " + str(self.zlpos) + "\n"
return string
def clear(self):
"""Resets Bloch sphere data sets to empty."""
self.points = []
self.vectors = []
self.point_style = []
self.annotations = []
def add_points(self, points, meth="s"):
"""Add a list of data points to Bloch sphere.
Args:
points (array_like):
Collection of data points.
meth (str):
Type of points to plot, use 'm' for multicolored, 'l' for points
connected with a line.
"""
if not isinstance(points[0], (list, np.ndarray)):
points = [[points[0]], [points[1]], [points[2]]]
points = np.array(points)
if meth == "s":
if len(points[0]) == 1:
pnts = np.array([[points[0][0]], [points[1][0]], [points[2][0]]])
pnts = np.append(pnts, points, axis=1)
else:
pnts = points
self.points.append(pnts)
self.point_style.append("s")
elif meth == "l":
self.points.append(points)
self.point_style.append("l")
else:
self.points.append(points)
self.point_style.append("m")
def add_vectors(self, vectors):
"""Add a list of vectors to Bloch sphere.
Args:
vectors (array_like):
Array with vectors of unit length or smaller.
"""
if isinstance(vectors[0], (list, np.ndarray)):
for vec in vectors:
self.vectors.append(vec)
else:
self.vectors.append(vectors)
def add_annotation(self, state_or_vector, text, **kwargs):
"""Add a text or LaTeX annotation to Bloch sphere,
parameterized by a qubit state or a vector.
Args:
state_or_vector (array_like):
Position for the annotation.
Qobj of a qubit or a vector of 3 elements.
text (str):
Annotation text.
You can use LaTeX, but remember to use raw string
e.g. r"$\\langle x \\rangle$"
or escape backslashes
e.g. "$\\\\langle x \\\\rangle$".
**kwargs:
Options as for mplot3d.axes3d.text, including:
fontsize, color, horizontalalignment, verticalalignment.
Raises:
Exception: If input not array_like or tuple.
"""
if isinstance(state_or_vector, (list, np.ndarray, tuple)) and len(state_or_vector) == 3:
vec = state_or_vector
else:
raise Exception("Position needs to be specified by a qubit " + "state or a 3D vector.")
self.annotations.append({"position": vec, "text": text, "opts": kwargs})
def make_sphere(self):
"""
Plots Bloch sphere and data sets.
"""
self.render()
def render(self, title=""):
"""
Render the Bloch sphere and its data sets in on given figure and axes.
"""
if self._rendered:
self.axes.clear()
self._rendered = True
# Figure instance for Bloch sphere plot
if not self._ext_fig:
self.fig = plt.figure(figsize=self.figsize)
if not self._ext_axes:
if tuple(int(x) for x in matplotlib.__version__.split(".")) >= (3, 4, 0):
self.axes = Axes3D(
self.fig, azim=self.view[0], elev=self.view[1], auto_add_to_figure=False
)
self.fig.add_axes(self.axes)
else:
self.axes = Axes3D(
self.fig,
azim=self.view[0],
elev=self.view[1],
)
if self.background:
self.axes.clear()
self.axes.set_xlim3d(-1.3, 1.3)
self.axes.set_ylim3d(-1.3, 1.3)
self.axes.set_zlim3d(-1.3, 1.3)
else:
self.plot_axes()
self.axes.set_axis_off()
self.axes.set_xlim3d(-0.7, 0.7)
self.axes.set_ylim3d(-0.7, 0.7)
self.axes.set_zlim3d(-0.7, 0.7)
# Force aspect ratio
# MPL 3.2 or previous do not have set_box_aspect
if hasattr(self.axes, "set_box_aspect"):
self.axes.set_box_aspect((1, 1, 1))
self.axes.grid(False)
self.plot_back()
self.plot_points()
self.plot_vectors()
self.plot_front()
self.plot_axes_labels()
self.plot_annotations()
self.axes.set_title(title, fontsize=self.font_size, y=1.08)
def plot_back(self):
"""back half of sphere"""
u_angle = np.linspace(0, np.pi, 25)
v_angle = np.linspace(0, np.pi, 25)
x_dir = np.outer(np.cos(u_angle), np.sin(v_angle))
y_dir = np.outer(np.sin(u_angle), np.sin(v_angle))
z_dir = np.outer(np.ones(u_angle.shape[0]), np.cos(v_angle))
self.axes.plot_surface(
x_dir,
y_dir,
z_dir,
rstride=2,
cstride=2,
color=self.sphere_color,
linewidth=0,
alpha=self.sphere_alpha,
)
# wireframe
self.axes.plot_wireframe(
x_dir,
y_dir,
z_dir,
rstride=5,
cstride=5,
color=self.frame_color,
alpha=self.frame_alpha,
)
# equator
self.axes.plot(
1.0 * np.cos(u_angle),
1.0 * np.sin(u_angle),
zs=0,
zdir="z",
lw=self.frame_width,
color=self.frame_color,
)
self.axes.plot(
1.0 * np.cos(u_angle),
1.0 * np.sin(u_angle),
zs=0,
zdir="x",
lw=self.frame_width,
color=self.frame_color,
)
def plot_front(self):
"""front half of sphere"""
u_angle = np.linspace(-np.pi, 0, 25)
v_angle = np.linspace(0, np.pi, 25)
x_dir = np.outer(np.cos(u_angle), np.sin(v_angle))
y_dir = np.outer(np.sin(u_angle), np.sin(v_angle))
z_dir = np.outer(np.ones(u_angle.shape[0]), np.cos(v_angle))
self.axes.plot_surface(
x_dir,
y_dir,
z_dir,
rstride=2,
cstride=2,
color=self.sphere_color,
linewidth=0,
alpha=self.sphere_alpha,
)
# wireframe
self.axes.plot_wireframe(
x_dir,
y_dir,
z_dir,
rstride=5,
cstride=5,
color=self.frame_color,
alpha=self.frame_alpha,
)
# equator
self.axes.plot(
1.0 * np.cos(u_angle),
1.0 * np.sin(u_angle),
zs=0,
zdir="z",
lw=self.frame_width,
color=self.frame_color,
)
self.axes.plot(
1.0 * np.cos(u_angle),
1.0 * np.sin(u_angle),
zs=0,
zdir="x",
lw=self.frame_width,
color=self.frame_color,
)
def plot_axes(self):
"""axes"""
span = np.linspace(-1.0, 1.0, 2)
self.axes.plot(
span, 0 * span, zs=0, zdir="z", label="X", lw=self.frame_width, color=self.frame_color
)
self.axes.plot(
0 * span, span, zs=0, zdir="z", label="Y", lw=self.frame_width, color=self.frame_color
)
self.axes.plot(
0 * span, span, zs=0, zdir="y", label="Z", lw=self.frame_width, color=self.frame_color
)
def plot_axes_labels(self):
"""axes labels"""
opts = {
"fontsize": self.font_size,
"color": self.font_color,
"horizontalalignment": "center",
"verticalalignment": "center",
}
self.axes.text(0, -self.xlpos[0], 0, self.xlabel[0], **opts)
self.axes.text(0, -self.xlpos[1], 0, self.xlabel[1], **opts)
self.axes.text(self.ylpos[0], 0, 0, self.ylabel[0], **opts)
self.axes.text(self.ylpos[1], 0, 0, self.ylabel[1], **opts)
self.axes.text(0, 0, self.zlpos[0], self.zlabel[0], **opts)
self.axes.text(0, 0, self.zlpos[1], self.zlabel[1], **opts)
for item in self.axes.xaxis.get_ticklines() + self.axes.xaxis.get_ticklabels():
item.set_visible(False)
for item in self.axes.yaxis.get_ticklines() + self.axes.yaxis.get_ticklabels():
item.set_visible(False)
for item in self.axes.zaxis.get_ticklines() + self.axes.zaxis.get_ticklabels():
item.set_visible(False)
def plot_vectors(self):
"""Plot vector"""
# -X and Y data are switched for plotting purposes
for k in range(len(self.vectors)):
xs3d = self.vectors[k][1] * np.array([0, 1])
ys3d = -self.vectors[k][0] * np.array([0, 1])
zs3d = self.vectors[k][2] * np.array([0, 1])
color = self.vector_color[np.mod(k, len(self.vector_color))]
if self.vector_style == "":
# simple line style
self.axes.plot(
xs3d, ys3d, zs3d, zs=0, zdir="z", label="Z", lw=self.vector_width, color=color
)
else:
# decorated style, with arrow heads
arr = Arrow3D(
xs3d,
ys3d,
zs3d,
mutation_scale=self.vector_mutation,
lw=self.vector_width,
arrowstyle=self.vector_style,
color=color,
)
self.axes.add_artist(arr)
def plot_points(self):
"""Plot points"""
# -X and Y data are switched for plotting purposes
for k in range(len(self.points)):
num = len(self.points[k][0])
dist = [
np.sqrt(
self.points[k][0][j] ** 2
+ self.points[k][1][j] ** 2
+ self.points[k][2][j] ** 2
)
for j in range(num)
]
if any(abs(dist - dist[0]) / dist[0] > 1e-12):
# combine arrays so that they can be sorted together
zipped = list(zip(dist, range(num)))
zipped.sort() # sort rates from lowest to highest
dist, indperm = zip(*zipped)
indperm = np.array(indperm)
else:
indperm = np.arange(num)
if self.point_style[k] == "s":
self.axes.scatter(
np.real(self.points[k][1][indperm]),
-np.real(self.points[k][0][indperm]),
np.real(self.points[k][2][indperm]),
s=self.point_size[np.mod(k, len(self.point_size))],
alpha=1,
edgecolor=None,
zdir="z",
color=self.point_color[np.mod(k, len(self.point_color))],
marker=self.point_marker[np.mod(k, len(self.point_marker))],
)
elif self.point_style[k] == "m":
pnt_colors = np.array(
self.point_color * int(np.ceil(num / float(len(self.point_color))))
)
pnt_colors = pnt_colors[0:num]
pnt_colors = list(pnt_colors[indperm])
marker = self.point_marker[np.mod(k, len(self.point_marker))]
pnt_size = self.point_size[np.mod(k, len(self.point_size))]
self.axes.scatter(
np.real(self.points[k][1][indperm]),
-np.real(self.points[k][0][indperm]),
np.real(self.points[k][2][indperm]),
s=pnt_size,
alpha=1,
edgecolor=None,
zdir="z",
color=pnt_colors,
marker=marker,
)
elif self.point_style[k] == "l":
color = self.point_color[np.mod(k, len(self.point_color))]
self.axes.plot(
np.real(self.points[k][1]),
-np.real(self.points[k][0]),
np.real(self.points[k][2]),
alpha=0.75,
zdir="z",
color=color,
)
def plot_annotations(self):
"""Plot annotations"""
# -X and Y data are switched for plotting purposes
for annotation in self.annotations:
vec = annotation["position"]
opts = {
"fontsize": self.font_size,
"color": self.font_color,
"horizontalalignment": "center",
"verticalalignment": "center",
}
opts.update(annotation["opts"])
self.axes.text(vec[1], -vec[0], vec[2], annotation["text"], **opts)
def show(self, title=""):
"""
Display Bloch sphere and corresponding data sets.
"""
self.render(title=title)
if self.fig:
plt.show(self.fig)
def save(self, name=None, output="png", dirc=None):
"""Saves Bloch sphere to file of type ``format`` in directory ``dirc``.
Args:
name (str):
Name of saved image. Must include path and format as well.
i.e. '/Users/Paul/Desktop/bloch.png'
This overrides the 'format' and 'dirc' arguments.
output (str):
Format of output image.
dirc (str):
Directory for output images. Defaults to current working directory.
"""
self.render()
if dirc:
if not os.path.isdir(os.getcwd() + "/" + str(dirc)):
os.makedirs(os.getcwd() + "/" + str(dirc))
if name is None:
if dirc:
self.fig.savefig(
os.getcwd() + "/" + str(dirc) + "/bloch_" + str(self.savenum) + "." + output
)
else:
self.fig.savefig(os.getcwd() + "/bloch_" + str(self.savenum) + "." + output)
else:
self.fig.savefig(name)
self.savenum += 1
if self.fig:
matplotlib_close_if_inline(self.fig)
def _hide_tick_lines_and_labels(axis):
"""
Set visible property of ticklines and ticklabels of an axis to False
"""
for item in axis.get_ticklines() + axis.get_ticklabels():
item.set_visible(False)