-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
/
axes3d.py
3336 lines (2776 loc) · 123 KB
/
axes3d.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
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
axes3d.py, original mplot3d version by John Porter
Created: 23 Sep 2005
Parts fixed by Reinier Heeres <reinier@heeres.eu>
Minor additions by Ben Axelrod <baxelrod@coroware.com>
Significant updates and revisions by Ben Root <ben.v.root@gmail.com>
Module containing Axes3D, an object which can plot 3D objects on a
2D matplotlib figure.
"""
from collections import defaultdict
import functools
import itertools
import math
import textwrap
import numpy as np
import matplotlib as mpl
from matplotlib import _api, cbook, _docstring, _preprocess_data
import matplotlib.artist as martist
import matplotlib.axes as maxes
import matplotlib.collections as mcoll
import matplotlib.colors as mcolors
import matplotlib.image as mimage
import matplotlib.lines as mlines
import matplotlib.patches as mpatches
import matplotlib.container as mcontainer
import matplotlib.transforms as mtransforms
from matplotlib.axes import Axes
from matplotlib.axes._base import _axis_method_wrapper, _process_plot_format
from matplotlib.transforms import Bbox
from matplotlib.tri._triangulation import Triangulation
from . import art3d
from . import proj3d
from . import axis3d
@_docstring.interpd
@_api.define_aliases({
"xlim": ["xlim3d"], "ylim": ["ylim3d"], "zlim": ["zlim3d"]})
class Axes3D(Axes):
"""
3D Axes object.
.. note::
As a user, you do not instantiate Axes directly, but use Axes creation
methods instead; e.g. from `.pyplot` or `.Figure`:
`~.pyplot.subplots`, `~.pyplot.subplot_mosaic` or `.Figure.add_axes`.
"""
name = '3d'
_axis_names = ("x", "y", "z")
Axes._shared_axes["z"] = cbook.Grouper()
dist = _api.deprecate_privatize_attribute("3.6")
vvec = _api.deprecate_privatize_attribute("3.7")
eye = _api.deprecate_privatize_attribute("3.7")
sx = _api.deprecate_privatize_attribute("3.7")
sy = _api.deprecate_privatize_attribute("3.7")
def __init__(
self, fig, rect=None, *args,
elev=30, azim=-60, roll=0, sharez=None, proj_type='persp',
box_aspect=None, computed_zorder=True, focal_length=None,
**kwargs):
"""
Parameters
----------
fig : Figure
The parent figure.
rect : tuple (left, bottom, width, height), default: None.
The ``(left, bottom, width, height)`` axes position.
elev : float, default: 30
The elevation angle in degrees rotates the camera above and below
the x-y plane, with a positive angle corresponding to a location
above the plane.
azim : float, default: -60
The azimuthal angle in degrees rotates the camera about the z axis,
with a positive angle corresponding to a right-handed rotation. In
other words, a positive azimuth rotates the camera about the origin
from its location along the +x axis towards the +y axis.
roll : float, default: 0
The roll angle in degrees rotates the camera about the viewing
axis. A positive angle spins the camera clockwise, causing the
scene to rotate counter-clockwise.
sharez : Axes3D, optional
Other Axes to share z-limits with.
proj_type : {'persp', 'ortho'}
The projection type, default 'persp'.
box_aspect : 3-tuple of floats, default: None
Changes the physical dimensions of the Axes3D, such that the ratio
of the axis lengths in display units is x:y:z.
If None, defaults to 4:4:3
computed_zorder : bool, default: True
If True, the draw order is computed based on the average position
of the `.Artist`\\s along the view direction.
Set to False if you want to manually control the order in which
Artists are drawn on top of each other using their *zorder*
attribute. This can be used for fine-tuning if the automatic order
does not produce the desired result. Note however, that a manual
zorder will only be correct for a limited view angle. If the figure
is rotated by the user, it will look wrong from certain angles.
focal_length : float, default: None
For a projection type of 'persp', the focal length of the virtual
camera. Must be > 0. If None, defaults to 1.
For a projection type of 'ortho', must be set to either None
or infinity (numpy.inf). If None, defaults to infinity.
The focal length can be computed from a desired Field Of View via
the equation: focal_length = 1/tan(FOV/2)
**kwargs
Other optional keyword arguments:
%(Axes3D:kwdoc)s
"""
if rect is None:
rect = [0.0, 0.0, 1.0, 1.0]
self.initial_azim = azim
self.initial_elev = elev
self.initial_roll = roll
self.set_proj_type(proj_type, focal_length)
self.computed_zorder = computed_zorder
self.xy_viewLim = Bbox.unit()
self.zz_viewLim = Bbox.unit()
self.xy_dataLim = Bbox.unit()
# z-limits are encoded in the x-component of the Bbox, y is un-used
self.zz_dataLim = Bbox.unit()
# inhibit autoscale_view until the axes are defined
# they can't be defined until Axes.__init__ has been called
self.view_init(self.initial_elev, self.initial_azim, self.initial_roll)
self._sharez = sharez
if sharez is not None:
self._shared_axes["z"].join(self, sharez)
self._adjustable = 'datalim'
if kwargs.pop('auto_add_to_figure', False):
raise AttributeError(
'auto_add_to_figure is no longer supported for Axes3D. '
'Use fig.add_axes(ax) instead.'
)
super().__init__(
fig, rect, frameon=True, box_aspect=box_aspect, *args, **kwargs
)
# Disable drawing of axes by base class
super().set_axis_off()
# Enable drawing of axes by Axes3D class
self.set_axis_on()
self.M = None
# func used to format z -- fall back on major formatters
self.fmt_zdata = None
self.mouse_init()
self.figure.canvas.callbacks._connect_picklable(
'motion_notify_event', self._on_move)
self.figure.canvas.callbacks._connect_picklable(
'button_press_event', self._button_press)
self.figure.canvas.callbacks._connect_picklable(
'button_release_event', self._button_release)
self.set_top_view()
self.patch.set_linewidth(0)
# Calculate the pseudo-data width and height
pseudo_bbox = self.transLimits.inverted().transform([(0, 0), (1, 1)])
self._pseudo_w, self._pseudo_h = pseudo_bbox[1] - pseudo_bbox[0]
# mplot3d currently manages its own spines and needs these turned off
# for bounding box calculations
self.spines[:].set_visible(False)
def set_axis_off(self):
self._axis3don = False
self.stale = True
def set_axis_on(self):
self._axis3don = True
self.stale = True
def convert_zunits(self, z):
"""
For artists in an Axes, if the zaxis has units support,
convert *z* using zaxis unit type
"""
return self.zaxis.convert_units(z)
def set_top_view(self):
# this happens to be the right view for the viewing coordinates
# moved up and to the left slightly to fit labels and axes
xdwl = 0.95 / self._dist
xdw = 0.9 / self._dist
ydwl = 0.95 / self._dist
ydw = 0.9 / self._dist
# Set the viewing pane.
self.viewLim.intervalx = (-xdwl, xdw)
self.viewLim.intervaly = (-ydwl, ydw)
self.stale = True
def _init_axis(self):
"""Init 3D axes; overrides creation of regular X/Y axes."""
self.xaxis = axis3d.XAxis(self)
self.yaxis = axis3d.YAxis(self)
self.zaxis = axis3d.ZAxis(self)
def get_zaxis(self):
"""Return the ``ZAxis`` (`~.axis3d.Axis`) instance."""
return self.zaxis
get_zgridlines = _axis_method_wrapper("zaxis", "get_gridlines")
get_zticklines = _axis_method_wrapper("zaxis", "get_ticklines")
w_xaxis = _api.deprecated("3.1", alternative="xaxis", removal="3.8")(
property(lambda self: self.xaxis))
w_yaxis = _api.deprecated("3.1", alternative="yaxis", removal="3.8")(
property(lambda self: self.yaxis))
w_zaxis = _api.deprecated("3.1", alternative="zaxis", removal="3.8")(
property(lambda self: self.zaxis))
@_api.deprecated("3.7")
def unit_cube(self, vals=None):
return self._unit_cube(vals)
def _unit_cube(self, vals=None):
minx, maxx, miny, maxy, minz, maxz = vals or self.get_w_lims()
return [(minx, miny, minz),
(maxx, miny, minz),
(maxx, maxy, minz),
(minx, maxy, minz),
(minx, miny, maxz),
(maxx, miny, maxz),
(maxx, maxy, maxz),
(minx, maxy, maxz)]
@_api.deprecated("3.7")
def tunit_cube(self, vals=None, M=None):
return self._tunit_cube(vals, M)
def _tunit_cube(self, vals=None, M=None):
if M is None:
M = self.M
xyzs = self._unit_cube(vals)
tcube = proj3d.proj_points(xyzs, M)
return tcube
@_api.deprecated("3.7")
def tunit_edges(self, vals=None, M=None):
return self._tunit_edges(vals, M)
def _tunit_edges(self, vals=None, M=None):
tc = self._tunit_cube(vals, M)
edges = [(tc[0], tc[1]),
(tc[1], tc[2]),
(tc[2], tc[3]),
(tc[3], tc[0]),
(tc[0], tc[4]),
(tc[1], tc[5]),
(tc[2], tc[6]),
(tc[3], tc[7]),
(tc[4], tc[5]),
(tc[5], tc[6]),
(tc[6], tc[7]),
(tc[7], tc[4])]
return edges
def set_aspect(self, aspect, adjustable=None, anchor=None, share=False):
"""
Set the aspect ratios.
Parameters
----------
aspect : {'auto', 'equal', 'equalxy', 'equalxz', 'equalyz'}
Possible values:
========= ==================================================
value description
========= ==================================================
'auto' automatic; fill the position rectangle with data.
'equal' adapt all the axes to have equal aspect ratios.
'equalxy' adapt the x and y axes to have equal aspect ratios.
'equalxz' adapt the x and z axes to have equal aspect ratios.
'equalyz' adapt the y and z axes to have equal aspect ratios.
========= ==================================================
adjustable : None or {'box', 'datalim'}, optional
If not *None*, this defines which parameter will be adjusted to
meet the required aspect. See `.set_adjustable` for further
details.
anchor : None or str or 2-tuple of float, optional
If not *None*, this defines where the Axes will be drawn if there
is extra space due to aspect constraints. The most common way to
specify the anchor are abbreviations of cardinal directions:
===== =====================
value description
===== =====================
'C' centered
'SW' lower left corner
'S' middle of bottom edge
'SE' lower right corner
etc.
===== =====================
See `~.Axes.set_anchor` for further details.
share : bool, default: False
If ``True``, apply the settings to all shared Axes.
See Also
--------
mpl_toolkits.mplot3d.axes3d.Axes3D.set_box_aspect
"""
_api.check_in_list(('auto', 'equal', 'equalxy', 'equalyz', 'equalxz'),
aspect=aspect)
super().set_aspect(
aspect='auto', adjustable=adjustable, anchor=anchor, share=share)
self._aspect = aspect
if aspect in ('equal', 'equalxy', 'equalxz', 'equalyz'):
ax_indices = self._equal_aspect_axis_indices(aspect)
view_intervals = np.array([self.xaxis.get_view_interval(),
self.yaxis.get_view_interval(),
self.zaxis.get_view_interval()])
ptp = np.ptp(view_intervals, axis=1)
if self._adjustable == 'datalim':
mean = np.mean(view_intervals, axis=1)
delta = max(ptp[ax_indices])
scale = self._box_aspect[ptp == delta][0]
deltas = delta * self._box_aspect / scale
for i, set_lim in enumerate((self.set_xlim3d,
self.set_ylim3d,
self.set_zlim3d)):
if i in ax_indices:
set_lim(mean[i] - deltas[i]/2., mean[i] + deltas[i]/2.)
else: # 'box'
# Change the box aspect such that the ratio of the length of
# the unmodified axis to the length of the diagonal
# perpendicular to it remains unchanged.
box_aspect = np.array(self._box_aspect)
box_aspect[ax_indices] = ptp[ax_indices]
remaining_ax_indices = {0, 1, 2}.difference(ax_indices)
if remaining_ax_indices:
remaining = remaining_ax_indices.pop()
old_diag = np.linalg.norm(self._box_aspect[ax_indices])
new_diag = np.linalg.norm(box_aspect[ax_indices])
box_aspect[remaining] *= new_diag / old_diag
self.set_box_aspect(box_aspect)
def _equal_aspect_axis_indices(self, aspect):
"""
Get the indices for which of the x, y, z axes are constrained to have
equal aspect ratios.
Parameters
----------
aspect : {'auto', 'equal', 'equalxy', 'equalxz', 'equalyz'}
See descriptions in docstring for `.set_aspect()`.
"""
ax_indices = [] # aspect == 'auto'
if aspect == 'equal':
ax_indices = [0, 1, 2]
elif aspect == 'equalxy':
ax_indices = [0, 1]
elif aspect == 'equalxz':
ax_indices = [0, 2]
elif aspect == 'equalyz':
ax_indices = [1, 2]
return ax_indices
def set_box_aspect(self, aspect, *, zoom=1):
"""
Set the Axes box aspect.
The box aspect is the ratio of height to width in display
units for each face of the box when viewed perpendicular to
that face. This is not to be confused with the data aspect (see
`~.Axes3D.set_aspect`). The default ratios are 4:4:3 (x:y:z).
To simulate having equal aspect in data space, set the box
aspect to match your data range in each dimension.
*zoom* controls the overall size of the Axes3D in the figure.
Parameters
----------
aspect : 3-tuple of floats or None
Changes the physical dimensions of the Axes3D, such that the ratio
of the axis lengths in display units is x:y:z.
If None, defaults to (4, 4, 3).
zoom : float, default: 1
Control overall size of the Axes3D in the figure. Must be > 0.
"""
if zoom <= 0:
raise ValueError(f'Argument zoom = {zoom} must be > 0')
if aspect is None:
aspect = np.asarray((4, 4, 3), dtype=float)
else:
aspect = np.asarray(aspect, dtype=float)
_api.check_shape((3,), aspect=aspect)
# default scale tuned to match the mpl32 appearance.
aspect *= 1.8294640721620434 * zoom / np.linalg.norm(aspect)
self._box_aspect = aspect
self.stale = True
def apply_aspect(self, position=None):
if position is None:
position = self.get_position(original=True)
# in the superclass, we would go through and actually deal with axis
# scales and box/datalim. Those are all irrelevant - all we need to do
# is make sure our coordinate system is square.
trans = self.get_figure().transSubfigure
bb = mtransforms.Bbox.unit().transformed(trans)
# this is the physical aspect of the panel (or figure):
fig_aspect = bb.height / bb.width
box_aspect = 1
pb = position.frozen()
pb1 = pb.shrunk_to_aspect(box_aspect, pb, fig_aspect)
self._set_position(pb1.anchored(self.get_anchor(), pb), 'active')
@martist.allow_rasterization
def draw(self, renderer):
if not self.get_visible():
return
self._unstale_viewLim()
# draw the background patch
self.patch.draw(renderer)
self._frameon = False
# first, set the aspect
# this is duplicated from `axes._base._AxesBase.draw`
# but must be called before any of the artist are drawn as
# it adjusts the view limits and the size of the bounding box
# of the Axes
locator = self.get_axes_locator()
self.apply_aspect(locator(self, renderer) if locator else None)
# add the projection matrix to the renderer
self.M = self.get_proj()
collections_and_patches = (
artist for artist in self._children
if isinstance(artist, (mcoll.Collection, mpatches.Patch))
and artist.get_visible())
if self.computed_zorder:
# Calculate projection of collections and patches and zorder
# them. Make sure they are drawn above the grids.
zorder_offset = max(axis.get_zorder()
for axis in self._axis_map.values()) + 1
collection_zorder = patch_zorder = zorder_offset
for artist in sorted(collections_and_patches,
key=lambda artist: artist.do_3d_projection(),
reverse=True):
if isinstance(artist, mcoll.Collection):
artist.zorder = collection_zorder
collection_zorder += 1
elif isinstance(artist, mpatches.Patch):
artist.zorder = patch_zorder
patch_zorder += 1
else:
for artist in collections_and_patches:
artist.do_3d_projection()
if self._axis3don:
# Draw panes first
for axis in self._axis_map.values():
axis.draw_pane(renderer)
# Then axes
for axis in self._axis_map.values():
axis.draw(renderer)
# Then rest
super().draw(renderer)
def get_axis_position(self):
vals = self.get_w_lims()
tc = self._tunit_cube(vals, self.M)
xhigh = tc[1][2] > tc[2][2]
yhigh = tc[3][2] > tc[2][2]
zhigh = tc[0][2] > tc[2][2]
return xhigh, yhigh, zhigh
def update_datalim(self, xys, **kwargs):
"""
Not implemented in `~mpl_toolkits.mplot3d.axes3d.Axes3D`.
"""
pass
get_autoscalez_on = _axis_method_wrapper("zaxis", "_get_autoscale_on")
set_autoscalez_on = _axis_method_wrapper("zaxis", "_set_autoscale_on")
def set_zmargin(self, m):
"""
Set padding of Z data limits prior to autoscaling.
*m* times the data interval will be added to each end of that interval
before it is used in autoscaling. If *m* is negative, this will clip
the data range instead of expanding it.
For example, if your data is in the range [0, 2], a margin of 0.1 will
result in a range [-0.2, 2.2]; a margin of -0.1 will result in a range
of [0.2, 1.8].
Parameters
----------
m : float greater than -0.5
"""
if m <= -0.5:
raise ValueError("margin must be greater than -0.5")
self._zmargin = m
self._request_autoscale_view("z")
self.stale = True
def margins(self, *margins, x=None, y=None, z=None, tight=True):
"""
Set or retrieve autoscaling margins.
See `.Axes.margins` for full documentation. Because this function
applies to 3D Axes, it also takes a *z* argument, and returns
``(xmargin, ymargin, zmargin)``.
"""
if margins and (x is not None or y is not None or z is not None):
raise TypeError('Cannot pass both positional and keyword '
'arguments for x, y, and/or z.')
elif len(margins) == 1:
x = y = z = margins[0]
elif len(margins) == 3:
x, y, z = margins
elif margins:
raise TypeError('Must pass a single positional argument for all '
'margins, or one for each margin (x, y, z).')
if x is None and y is None and z is None:
if tight is not True:
_api.warn_external(f'ignoring tight={tight!r} in get mode')
return self._xmargin, self._ymargin, self._zmargin
if x is not None:
self.set_xmargin(x)
if y is not None:
self.set_ymargin(y)
if z is not None:
self.set_zmargin(z)
self.autoscale_view(
tight=tight, scalex=(x is not None), scaley=(y is not None),
scalez=(z is not None)
)
def autoscale(self, enable=True, axis='both', tight=None):
"""
Convenience method for simple axis view autoscaling.
See `.Axes.autoscale` for full documentation. Because this function
applies to 3D Axes, *axis* can also be set to 'z', and setting *axis*
to 'both' autoscales all three axes.
"""
if enable is None:
scalex = True
scaley = True
scalez = True
else:
if axis in ['x', 'both']:
self.set_autoscalex_on(bool(enable))
scalex = self.get_autoscalex_on()
else:
scalex = False
if axis in ['y', 'both']:
self.set_autoscaley_on(bool(enable))
scaley = self.get_autoscaley_on()
else:
scaley = False
if axis in ['z', 'both']:
self.set_autoscalez_on(bool(enable))
scalez = self.get_autoscalez_on()
else:
scalez = False
if scalex:
self._request_autoscale_view("x", tight=tight)
if scaley:
self._request_autoscale_view("y", tight=tight)
if scalez:
self._request_autoscale_view("z", tight=tight)
def auto_scale_xyz(self, X, Y, Z=None, had_data=None):
# This updates the bounding boxes as to keep a record as to what the
# minimum sized rectangular volume holds the data.
if np.shape(X) == np.shape(Y):
self.xy_dataLim.update_from_data_xy(
np.column_stack([np.ravel(X), np.ravel(Y)]), not had_data)
else:
self.xy_dataLim.update_from_data_x(X, not had_data)
self.xy_dataLim.update_from_data_y(Y, not had_data)
if Z is not None:
self.zz_dataLim.update_from_data_x(Z, not had_data)
# Let autoscale_view figure out how to use this data.
self.autoscale_view()
def autoscale_view(self, tight=None, scalex=True, scaley=True,
scalez=True):
"""
Autoscale the view limits using the data limits.
See `.Axes.autoscale_view` for full documentation. Because this
function applies to 3D Axes, it also takes a *scalez* argument.
"""
# This method looks at the rectangular volume (see above)
# of data and decides how to scale the view portal to fit it.
if tight is None:
_tight = self._tight
if not _tight:
# if image data only just use the datalim
for artist in self._children:
if isinstance(artist, mimage.AxesImage):
_tight = True
elif isinstance(artist, (mlines.Line2D, mpatches.Patch)):
_tight = False
break
else:
_tight = self._tight = bool(tight)
if scalex and self.get_autoscalex_on():
self._shared_axes["x"].clean()
x0, x1 = self.xy_dataLim.intervalx
xlocator = self.xaxis.get_major_locator()
x0, x1 = xlocator.nonsingular(x0, x1)
if self._xmargin > 0:
delta = (x1 - x0) * self._xmargin
x0 -= delta
x1 += delta
if not _tight:
x0, x1 = xlocator.view_limits(x0, x1)
self.set_xbound(x0, x1)
if scaley and self.get_autoscaley_on():
self._shared_axes["y"].clean()
y0, y1 = self.xy_dataLim.intervaly
ylocator = self.yaxis.get_major_locator()
y0, y1 = ylocator.nonsingular(y0, y1)
if self._ymargin > 0:
delta = (y1 - y0) * self._ymargin
y0 -= delta
y1 += delta
if not _tight:
y0, y1 = ylocator.view_limits(y0, y1)
self.set_ybound(y0, y1)
if scalez and self.get_autoscalez_on():
self._shared_axes["z"].clean()
z0, z1 = self.zz_dataLim.intervalx
zlocator = self.zaxis.get_major_locator()
z0, z1 = zlocator.nonsingular(z0, z1)
if self._zmargin > 0:
delta = (z1 - z0) * self._zmargin
z0 -= delta
z1 += delta
if not _tight:
z0, z1 = zlocator.view_limits(z0, z1)
self.set_zbound(z0, z1)
def get_w_lims(self):
"""Get 3D world limits."""
minx, maxx = self.get_xlim3d()
miny, maxy = self.get_ylim3d()
minz, maxz = self.get_zlim3d()
return minx, maxx, miny, maxy, minz, maxz
# set_xlim, set_ylim are directly inherited from base Axes.
@_api.make_keyword_only("3.6", "emit")
def set_zlim(self, bottom=None, top=None, emit=True, auto=False,
*, zmin=None, zmax=None):
"""
Set 3D z limits.
See `.Axes.set_ylim` for full documentation
"""
if top is None and np.iterable(bottom):
bottom, top = bottom
if zmin is not None:
if bottom is not None:
raise TypeError("Cannot pass both 'bottom' and 'zmin'")
bottom = zmin
if zmax is not None:
if top is not None:
raise TypeError("Cannot pass both 'top' and 'zmax'")
top = zmax
return self.zaxis._set_lim(bottom, top, emit=emit, auto=auto)
set_xlim3d = maxes.Axes.set_xlim
set_ylim3d = maxes.Axes.set_ylim
set_zlim3d = set_zlim
def get_xlim(self):
# docstring inherited
return tuple(self.xy_viewLim.intervalx)
def get_ylim(self):
# docstring inherited
return tuple(self.xy_viewLim.intervaly)
def get_zlim(self):
"""Get 3D z limits."""
return tuple(self.zz_viewLim.intervalx)
get_zscale = _axis_method_wrapper("zaxis", "get_scale")
# Redefine all three methods to overwrite their docstrings.
set_xscale = _axis_method_wrapper("xaxis", "_set_axes_scale")
set_yscale = _axis_method_wrapper("yaxis", "_set_axes_scale")
set_zscale = _axis_method_wrapper("zaxis", "_set_axes_scale")
set_xscale.__doc__, set_yscale.__doc__, set_zscale.__doc__ = map(
"""
Set the {}-axis scale.
Parameters
----------
value : {{"linear"}}
The axis scale type to apply. 3D axes currently only support
linear scales; other scales yield nonsensical results.
**kwargs
Keyword arguments are nominally forwarded to the scale class, but
none of them is applicable for linear scales.
""".format,
["x", "y", "z"])
get_zticks = _axis_method_wrapper("zaxis", "get_ticklocs")
set_zticks = _axis_method_wrapper("zaxis", "set_ticks")
get_zmajorticklabels = _axis_method_wrapper("zaxis", "get_majorticklabels")
get_zminorticklabels = _axis_method_wrapper("zaxis", "get_minorticklabels")
get_zticklabels = _axis_method_wrapper("zaxis", "get_ticklabels")
set_zticklabels = _axis_method_wrapper(
"zaxis", "set_ticklabels",
doc_sub={"Axis.set_ticks": "Axes3D.set_zticks"})
zaxis_date = _axis_method_wrapper("zaxis", "axis_date")
if zaxis_date.__doc__:
zaxis_date.__doc__ += textwrap.dedent("""
Notes
-----
This function is merely provided for completeness, but 3D axes do not
support dates for ticks, and so this may not work as expected.
""")
def clabel(self, *args, **kwargs):
"""Currently not implemented for 3D axes, and returns *None*."""
return None
def view_init(self, elev=None, azim=None, roll=None, vertical_axis="z"):
"""
Set the elevation and azimuth of the axes in degrees (not radians).
This can be used to rotate the axes programmatically.
To look normal to the primary planes, the following elevation and
azimuth angles can be used. A roll angle of 0, 90, 180, or 270 deg
will rotate these views while keeping the axes at right angles.
========== ==== ====
view plane elev azim
========== ==== ====
XY 90 -90
XZ 0 -90
YZ 0 0
-XY -90 90
-XZ 0 90
-YZ 0 180
========== ==== ====
Parameters
----------
elev : float, default: None
The elevation angle in degrees rotates the camera above the plane
pierced by the vertical axis, with a positive angle corresponding
to a location above that plane. For example, with the default
vertical axis of 'z', the elevation defines the angle of the camera
location above the x-y plane.
If None, then the initial value as specified in the `Axes3D`
constructor is used.
azim : float, default: None
The azimuthal angle in degrees rotates the camera about the
vertical axis, with a positive angle corresponding to a
right-handed rotation. For example, with the default vertical axis
of 'z', a positive azimuth rotates the camera about the origin from
its location along the +x axis towards the +y axis.
If None, then the initial value as specified in the `Axes3D`
constructor is used.
roll : float, default: None
The roll angle in degrees rotates the camera about the viewing
axis. A positive angle spins the camera clockwise, causing the
scene to rotate counter-clockwise.
If None, then the initial value as specified in the `Axes3D`
constructor is used.
vertical_axis : {"z", "x", "y"}, default: "z"
The axis to align vertically. *azim* rotates about this axis.
"""
self._dist = 10 # The camera distance from origin. Behaves like zoom
if elev is None:
self.elev = self.initial_elev
else:
self.elev = elev
if azim is None:
self.azim = self.initial_azim
else:
self.azim = azim
if roll is None:
self.roll = self.initial_roll
else:
self.roll = roll
self._vertical_axis = _api.check_getitem(
dict(x=0, y=1, z=2), vertical_axis=vertical_axis
)
def set_proj_type(self, proj_type, focal_length=None):
"""
Set the projection type.
Parameters
----------
proj_type : {'persp', 'ortho'}
The projection type.
focal_length : float, default: None
For a projection type of 'persp', the focal length of the virtual
camera. Must be > 0. If None, defaults to 1.
The focal length can be computed from a desired Field Of View via
the equation: focal_length = 1/tan(FOV/2)
"""
_api.check_in_list(['persp', 'ortho'], proj_type=proj_type)
if proj_type == 'persp':
if focal_length is None:
focal_length = 1
elif focal_length <= 0:
raise ValueError(f"focal_length = {focal_length} must be "
"greater than 0")
self._focal_length = focal_length
else: # 'ortho':
if focal_length not in (None, np.inf):
raise ValueError(f"focal_length = {focal_length} must be "
f"None for proj_type = {proj_type}")
self._focal_length = np.inf
def _roll_to_vertical(self, arr):
"""Roll arrays to match the different vertical axis."""
return np.roll(arr, self._vertical_axis - 2)
def get_proj(self):
"""Create the projection matrix from the current viewing position."""
# Transform to uniform world coordinates 0-1, 0-1, 0-1
box_aspect = self._roll_to_vertical(self._box_aspect)
worldM = proj3d.world_transformation(
*self.get_xlim3d(),
*self.get_ylim3d(),
*self.get_zlim3d(),
pb_aspect=box_aspect,
)
# Look into the middle of the world coordinates:
R = 0.5 * box_aspect
# elev stores the elevation angle in the z plane
# azim stores the azimuth angle in the x,y plane
elev_rad = np.deg2rad(art3d._norm_angle(self.elev))
azim_rad = np.deg2rad(art3d._norm_angle(self.azim))
# Coordinates for a point that rotates around the box of data.
# p0, p1 corresponds to rotating the box only around the
# vertical axis.
# p2 corresponds to rotating the box only around the horizontal
# axis.
p0 = np.cos(elev_rad) * np.cos(azim_rad)
p1 = np.cos(elev_rad) * np.sin(azim_rad)
p2 = np.sin(elev_rad)
# When changing vertical axis the coordinates changes as well.
# Roll the values to get the same behaviour as the default:
ps = self._roll_to_vertical([p0, p1, p2])
# The coordinates for the eye viewing point. The eye is looking
# towards the middle of the box of data from a distance:
eye = R + self._dist * ps
# vvec, self._vvec and self._eye are unused, remove when deprecated
vvec = R - eye
self._eye = eye
self._vvec = vvec / np.linalg.norm(vvec)
# Calculate the viewing axes for the eye position
u, v, w = self._calc_view_axes(eye)
self._view_u = u # _view_u is towards the right of the screen
self._view_v = v # _view_v is towards the top of the screen
self._view_w = w # _view_w is out of the screen
# Generate the view and projection transformation matrices
if self._focal_length == np.inf:
# Orthographic projection
viewM = proj3d._view_transformation_uvw(u, v, w, eye)
projM = proj3d.ortho_transformation(-self._dist, self._dist)
else:
# Perspective projection
# Scale the eye dist to compensate for the focal length zoom effect
eye_focal = R + self._dist * ps * self._focal_length
viewM = proj3d._view_transformation_uvw(u, v, w, eye_focal)
projM = proj3d.persp_transformation(-self._dist,
self._dist,
self._focal_length)
# Combine all the transformation matrices to get the final projection
M0 = np.dot(viewM, worldM)
M = np.dot(projM, M0)
return M
def mouse_init(self, rotate_btn=1, pan_btn=2, zoom_btn=3):
"""
Set the mouse buttons for 3D rotation and zooming.
Parameters
----------
rotate_btn : int or list of int, default: 1
The mouse button or buttons to use for 3D rotation of the axes.
pan_btn : int or list of int, default: 2
The mouse button or buttons to use to pan the 3D axes.
zoom_btn : int or list of int, default: 3
The mouse button or buttons to use to zoom the 3D axes.
"""
self.button_pressed = None
# coerce scalars into array-like, then convert into
# a regular list to avoid comparisons against None
# which breaks in recent versions of numpy.
self._rotate_btn = np.atleast_1d(rotate_btn).tolist()
self._pan_btn = np.atleast_1d(pan_btn).tolist()
self._zoom_btn = np.atleast_1d(zoom_btn).tolist()
def disable_mouse_rotation(self):
"""Disable mouse buttons for 3D rotation, panning, and zooming."""
self.mouse_init(rotate_btn=[], pan_btn=[], zoom_btn=[])
def can_zoom(self):
"""
Return whether this Axes supports the zoom box button functionality.
"""
return True
def can_pan(self):
"""
Return whether this Axes supports the pan button functionality.
"""
return True
def sharez(self, other):
"""
Share the z-axis with *other*.
This is equivalent to passing ``sharez=other`` when constructing the
Axes, and cannot be used if the z-axis is already being shared with
another Axes.
"""
_api.check_isinstance(maxes._base._AxesBase, other=other)
if self._sharez is not None and other is not self._sharez:
raise ValueError("z-axis is already shared")
self._shared_axes["z"].join(self, other)
self._sharez = other
self.zaxis.major = other.zaxis.major # Ticker instances holding
self.zaxis.minor = other.zaxis.minor # locator and formatter.
z0, z1 = other.get_zlim()
self.set_zlim(z0, z1, emit=False, auto=other.get_autoscalez_on())
self.zaxis._scale = other.zaxis._scale
def clear(self):
# docstring inherited.
super().clear()
if self._focal_length == np.inf:
self._zmargin = mpl.rcParams['axes.zmargin']
else: