FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
matplotlib/lib/matplotlib/lines.py at main · matplotlib/matplotlib · GitHub
matplotlib
matplotlib
Repository navigation
Code
Issues
1.1k
(1.1k)
Pull requests
425
(425)
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
matplotlib
/
lib
/
matplotlib
/
lines.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
1756 lines (1472 loc) · 58.9 KB
Breadcrumbs
matplotlib
/
lib
/
matplotlib
/
lines.py
Copy path
File metadata and controls
1756 lines (1472 loc) · 58.9 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
"""
2D lines with support for a variety of line styles, markers, colors, etc.
"""
import
copy
from
numbers
import
Integral
,
Number
,
Real
import
logging
import
numpy
as
np
import
matplotlib
as
mpl
from
.
import
_api
,
cbook
,
colors
as
mcolors
,
_docstring
from
.
artist
import
Artist
,
allow_rasterization
from
.
cbook
import
(
_to_unmasked_float_array
,
ls_mapper
,
ls_mapper_r
,
STEP_LOOKUP_MAP
)
from
.
markers
import
MarkerStyle
from
.
path
import
Path
from
.
transforms
import
Bbox
,
BboxTransformTo
,
TransformedPath
from
.
_enums
import
JoinStyle
,
CapStyle
# Imported here for backward compatibility, even though they don't
# really belong.
from
.
import
_path
from
.
markers
import
(
# noqa
CARETLEFT
,
CARETRIGHT
,
CARETUP
,
CARETDOWN
,
CARETLEFTBASE
,
CARETRIGHTBASE
,
CARETUPBASE
,
CARETDOWNBASE
,
TICKLEFT
,
TICKRIGHT
,
TICKUP
,
TICKDOWN
)
_log
=
logging
.
getLogger
(
__name__
)
def
_get_dash_pattern
(
style
):
"""Convert linestyle to dash pattern."""
# go from short hand -> full strings
if
isinstance
(
style
,
str
):
style
=
ls_mapper
.
get
(
style
,
style
)
# un-dashed styles
if
style
in
[
'solid'
,
'None'
,
'none'
,
''
,
' '
]:
offset
=
0
dashes
=
None
# dashed styles
elif
style
in
[
'dashed'
,
'dashdot'
,
'dotted'
]:
offset
=
0
dashes
=
tuple
(
mpl
.
rcParams
[
f'lines.
{
style
}
_pattern'
])
#
elif
isinstance
(
style
,
tuple
):
offset
,
dashes
=
style
if
offset
is
None
:
raise
ValueError
(
f'Unrecognized linestyle:
{
style
!r
}
'
)
else
:
raise
ValueError
(
f'Unrecognized linestyle:
{
style
!r
}
'
)
# normalize offset to be positive and shorter than the dash cycle
if
dashes
is
not
None
:
dsum
=
sum
(
dashes
)
if
dsum
:
offset
%=
dsum
return
offset
,
dashes
def
_get_dash_patterns
(
styles
):
"""Convert linestyle or sequence of linestyles to list of dash patterns."""
try
:
patterns
=
[
_get_dash_pattern
(
styles
)]
except
ValueError
:
try
:
patterns
=
[
_get_dash_pattern
(
x
)
for
x
in
styles
]
except
ValueError
as
err
:
emsg
=
f'Do not know how to convert
{
styles
!r
}
to dashes'
raise
ValueError
(
emsg
)
from
err
return
patterns
def
_get_inverse_dash_pattern
(
offset
,
dashes
):
"""Return the inverse of the given dash pattern, for filling the gaps."""
# Define the inverse pattern by moving the last gap to the start of the
# sequence.
gaps
=
dashes
[
-
1
:]
+
dashes
[:
-
1
]
# Set the offset so that this new first segment is skipped
# (see backend_bases.GraphicsContextBase.set_dashes for offset definition).
offset_gaps
=
offset
+
dashes
[
-
1
]
return
offset_gaps
,
gaps
def
_scale_dashes
(
offset
,
dashes
,
lw
):
if
not
mpl
.
rcParams
[
'lines.scale_dashes'
]:
return
offset
,
dashes
scaled_offset
=
offset
*
lw
scaled_dashes
=
([
x
*
lw
if
x
is
not
None
else
None
for
x
in
dashes
]
if
dashes
is
not
None
else
None
)
return
scaled_offset
,
scaled_dashes
def
segment_hits
(
cx
,
cy
,
x
,
y
,
radius
):
"""
Return the indices of the segments in the polyline with coordinates (*cx*,
*cy*) that are within a distance *radius* of the point (*x*, *y*).
"""
# Process single points specially
if
len
(
x
)
<=
1
:
res
,
=
np
.
nonzero
((
cx
-
x
)
**
2
+
(
cy
-
y
)
**
2
<=
radius
**
2
)
return
res
# We need to lop the last element off a lot.
xr
,
yr
=
x
[:
-
1
],
y
[:
-
1
]
# Only look at line segments whose nearest point to C on the line
# lies within the segment.
dx
,
dy
=
x
[
1
:]
-
xr
,
y
[
1
:]
-
yr
Lnorm_sq
=
dx
**
2
+
dy
**
2
# Possibly want to eliminate Lnorm==0
u
=
((
cx
-
xr
)
*
dx
+
(
cy
-
yr
)
*
dy
)
/
Lnorm_sq
candidates
=
(
u
>=
0
)
&
(
u
<=
1
)
# Note that there is a little area near one side of each point
# which will be near neither segment, and another which will
# be near both, depending on the angle of the lines. The
# following radius test eliminates these ambiguities.
point_hits
=
(
cx
-
x
)
**
2
+
(
cy
-
y
)
**
2
<=
radius
**
2
candidates
=
candidates
&
~
(
point_hits
[:
-
1
]
|
point_hits
[
1
:])
# For those candidates which remain, determine how far they lie away
# from the line.
px
,
py
=
xr
+
u
*
dx
,
yr
+
u
*
dy
line_hits
=
(
cx
-
px
)
**
2
+
(
cy
-
py
)
**
2
<=
radius
**
2
line_hits
=
line_hits
&
candidates
points
,
=
point_hits
.
ravel
().
nonzero
()
lines
,
=
line_hits
.
ravel
().
nonzero
()
return
np
.
concatenate
((
points
,
lines
))
def
_mark_every_path
(
markevery
,
tpath
,
affine
,
ax
):
"""
Helper function that sorts out how to deal the input
`markevery` and returns the points where markers should be drawn.
Takes in the `markevery` value and the line path and returns the
sub-sampled path.
"""
# pull out the two bits of data we want from the path
codes
,
verts
=
tpath
.
codes
,
tpath
.
vertices
def
_slice_or_none
(
in_v
,
slc
):
"""Helper function to cope with `codes` being an ndarray or `None`."""
if
in_v
is
None
:
return
None
return
in_v
[
slc
]
# if just an int, assume starting at 0 and make a tuple
if
isinstance
(
markevery
,
Integral
):
markevery
=
(
0
,
markevery
)
# if just a float, assume starting at 0.0 and make a tuple
elif
isinstance
(
markevery
,
Real
):
markevery
=
(
0.0
,
markevery
)
if
isinstance
(
markevery
,
tuple
):
if
len
(
markevery
)
!=
2
:
raise
ValueError
(
'`markevery` is a tuple but its len is not 2; '
f'markevery=
{
markevery
}
'
)
start
,
step
=
markevery
# if step is an int, old behavior
if
isinstance
(
step
,
Integral
):
# tuple of 2 int is for backwards compatibility,
if
not
isinstance
(
start
,
Integral
):
raise
ValueError
(
'`markevery` is a tuple with len 2 and second element is '
'an int, but the first element is not an int; '
f'markevery=
{
markevery
}
'
)
# just return, we are done here
return
Path
(
verts
[
slice
(
start
,
None
,
step
)],
_slice_or_none
(
codes
,
slice
(
start
,
None
,
step
)))
elif
isinstance
(
step
,
Real
):
if
not
isinstance
(
start
,
Real
):
raise
ValueError
(
'`markevery` is a tuple with len 2 and second element is '
'a float, but the first element is not a float or an int; '
f'markevery=
{
markevery
}
'
)
if
ax
is
None
:
raise
ValueError
(
"markevery is specified relative to the Axes size, but "
"the line does not have an Axes as parent"
)
# calc cumulative distance along path (in display coords):
fin
=
np
.
isfinite
(
verts
).
all
(
axis
=
1
)
fverts
=
verts
[
fin
]
disp_coords
=
affine
.
transform
(
fverts
)
delta
=
np
.
empty
((
len
(
disp_coords
),
2
))
delta
[
0
, :]
=
0
delta
[
1
:, :]
=
disp_coords
[
1
:, :]
-
disp_coords
[:
-
1
, :]
delta
=
np
.
hypot
(
*
delta
.
T
).
cumsum
()
# calc distance between markers along path based on the Axes
# bounding box diagonal being a distance of unity:
(
x0
,
y0
), (
x1
,
y1
)
=
ax
.
transAxes
.
transform
([[
0
,
0
], [
1
,
1
]])
scale
=
np
.
hypot
(
x1
-
x0
,
y1
-
y0
)
marker_start
=
start
*
scale
marker_step
=
step
*
scale
if
marker_step
<=
0
:
raise
ValueError
(
f"'markevery' step must be positive, but got
{
step
!r
}
"
)
# A theoretical marker can select a vertex only if the marker
# immediately before or after that vertex selects it. Limit
# the candidates to those markers instead of materializing
# every marker position, which may be arbitrarily large when
# zoomed in far enough.
marker_delta
=
delta
-
np
.
remainder
(
delta
-
marker_start
,
marker_step
)
marker_delta
=
np
.
union1d
(
marker_delta
,
marker_delta
+
marker_step
)
marker_delta
=
marker_delta
[
(
marker_delta
>=
marker_start
)
&
(
marker_delta
<
delta
[
-
1
])]
# Find each candidate's closest actual data point without
# constructing a len(marker_delta) x len(delta) array.
right
=
np
.
searchsorted
(
delta
,
marker_delta
,
side
=
"left"
)
left
=
np
.
maximum
(
right
-
1
,
0
)
right
=
np
.
minimum
(
right
,
len
(
delta
)
-
1
)
inds
=
np
.
where
(
np
.
abs
(
delta
[
right
]
-
marker_delta
)
<
np
.
abs
(
marker_delta
-
delta
[
left
]),
right
,
left
)
# If there are multiple vertices at a given distance, use the
# first one.
inds
=
np
.
searchsorted
(
delta
,
delta
[
inds
],
side
=
"left"
)
inds
=
np
.
unique
(
inds
)
# return, we are done here
return
Path
(
fverts
[
inds
],
_slice_or_none
(
codes
,
inds
))
else
:
raise
ValueError
(
f"markevery=
{
markevery
!r
}
is a tuple with len 2, but its "
f"second element is not an int or a float"
)
elif
isinstance
(
markevery
,
slice
):
# mazol tov, it's already a slice, just return
return
Path
(
verts
[
markevery
],
_slice_or_none
(
codes
,
markevery
))
elif
np
.
iterable
(
markevery
):
# fancy indexing
try
:
return
Path
(
verts
[
markevery
],
_slice_or_none
(
codes
,
markevery
))
except
(
ValueError
,
IndexError
)
as
err
:
raise
ValueError
(
f"markevery=
{
markevery
!r
}
is iterable but not a valid numpy "
f"fancy index"
)
from
err
else
:
raise
ValueError
(
f"markevery=
{
markevery
!r
}
is not a recognized value"
)
@
_docstring
.
interpd
@
_api
.
define_aliases
({
"antialiased"
: [
"aa"
],
"color"
: [
"c"
],
"drawstyle"
: [
"ds"
],
"linestyle"
: [
"ls"
],
"linewidth"
: [
"lw"
],
"markeredgecolor"
: [
"mec"
],
"markeredgewidth"
: [
"mew"
],
"markerfacecolor"
: [
"mfc"
],
"markerfacecoloralt"
: [
"mfcalt"
],
"markersize"
: [
"ms"
],
})
class
Line2D
(
Artist
):
"""
A line - the line can have both a solid linestyle connecting all
the vertices, and a marker at each vertex. Additionally, the
drawing of the solid line is influenced by the drawstyle, e.g., one
can create "stepped" lines in various styles.
"""
lineStyles
=
_lineStyles
=
{
# hidden names deprecated
'-'
:
'_draw_solid'
,
'--'
:
'_draw_dashed'
,
'-.'
:
'_draw_dash_dot'
,
':'
:
'_draw_dotted'
,
'None'
:
'_draw_nothing'
,
' '
:
'_draw_nothing'
,
''
:
'_draw_nothing'
,
}
_drawStyles_l
=
{
'default'
:
'_draw_lines'
,
'steps-mid'
:
'_draw_steps_mid'
,
'steps-pre'
:
'_draw_steps_pre'
,
'steps-post'
:
'_draw_steps_post'
,
}
_drawStyles_s
=
{
'steps'
:
'_draw_steps_pre'
,
}
# drawStyles should now be deprecated.
drawStyles
=
{
**
_drawStyles_l
,
**
_drawStyles_s
}
# Need a list ordered with long names first:
drawStyleKeys
=
[
*
_drawStyles_l
,
*
_drawStyles_s
]
# Referenced here to maintain API. These are defined in
# MarkerStyle
markers
=
MarkerStyle
.
markers
filled_markers
=
MarkerStyle
.
filled_markers
fillStyles
=
MarkerStyle
.
fillstyles
zorder
=
2
_subslice_optim_min_size
=
1000
def
__str__
(
self
):
if
self
.
_label
!=
""
:
return
f"Line2D(
{
self
.
_label
}
)"
elif
self
.
_x
is
None
:
return
"Line2D()"
elif
len
(
self
.
_x
)
>
3
:
return
"Line2D(({:g},{:g}),({:g},{:g}),...,({:g},{:g}))"
.
format
(
self
.
_x
[
0
],
self
.
_y
[
0
],
self
.
_x
[
1
],
self
.
_y
[
1
],
self
.
_x
[
-
1
],
self
.
_y
[
-
1
])
else
:
return
"Line2D(%s)"
%
","
.
join
(
map
(
"({:g},{:g})"
.
format
,
self
.
_x
,
self
.
_y
))
def
__init__
(
self
,
xdata
,
ydata
,
*
,
linewidth
=
None
,
# all Nones default to rc
linestyle
=
None
,
color
=
None
,
gapcolor
=
None
,
marker
=
None
,
markersize
=
None
,
markeredgewidth
=
None
,
markeredgecolor
=
None
,
markerfacecolor
=
None
,
markerfacecoloralt
=
'none'
,
fillstyle
=
None
,
antialiased
=
None
,
dash_capstyle
=
None
,
solid_capstyle
=
None
,
dash_joinstyle
=
None
,
solid_joinstyle
=
None
,
pickradius
=
5
,
drawstyle
=
None
,
markevery
=
None
,
**
kwargs
):
"""
Create a `.Line2D` instance with *x* and *y* data in sequences of
*xdata*, *ydata*.
Additional keyword arguments are `.Line2D` properties:
%(Line2D:kwdoc)s
See :meth:`set_linestyle` for a description of the line styles,
:meth:`set_marker` for a description of the markers, and
:meth:`set_drawstyle` for a description of the draw styles.
"""
super
().
__init__
()
# Convert sequences to NumPy arrays.
if
not
np
.
iterable
(
xdata
):
raise
RuntimeError
(
'xdata must be a sequence'
)
if
not
np
.
iterable
(
ydata
):
raise
RuntimeError
(
'ydata must be a sequence'
)
linewidth
=
mpl
.
_val_or_rc
(
linewidth
,
'lines.linewidth'
)
linestyle
=
mpl
.
_val_or_rc
(
linestyle
,
'lines.linestyle'
)
marker
=
mpl
.
_val_or_rc
(
marker
,
'lines.marker'
)
color
=
mpl
.
_val_or_rc
(
color
,
'lines.color'
)
markersize
=
mpl
.
_val_or_rc
(
markersize
,
'lines.markersize'
)
antialiased
=
mpl
.
_val_or_rc
(
antialiased
,
'lines.antialiased'
)
dash_capstyle
=
mpl
.
_val_or_rc
(
dash_capstyle
,
'lines.dash_capstyle'
)
dash_joinstyle
=
mpl
.
_val_or_rc
(
dash_joinstyle
,
'lines.dash_joinstyle'
)
solid_capstyle
=
mpl
.
_val_or_rc
(
solid_capstyle
,
'lines.solid_capstyle'
)
solid_joinstyle
=
mpl
.
_val_or_rc
(
solid_joinstyle
,
'lines.solid_joinstyle'
)
if
drawstyle
is
None
:
drawstyle
=
'default'
self
.
_dashcapstyle
=
None
self
.
_dashjoinstyle
=
None
self
.
_solidjoinstyle
=
None
self
.
_solidcapstyle
=
None
self
.
set_dash_capstyle
(
dash_capstyle
)
self
.
set_dash_joinstyle
(
dash_joinstyle
)
self
.
set_solid_capstyle
(
solid_capstyle
)
self
.
set_solid_joinstyle
(
solid_joinstyle
)
self
.
_linestyles
=
None
self
.
_drawstyle
=
None
self
.
_linewidth
=
linewidth
self
.
_unscaled_dash_pattern
=
(
0
,
None
)
# offset, dash
self
.
_dash_pattern
=
(
0
,
None
)
# offset, dash (scaled by linewidth)
self
.
set_linewidth
(
linewidth
)
self
.
set_linestyle
(
linestyle
)
self
.
set_drawstyle
(
drawstyle
)
self
.
_color
=
None
self
.
set_color
(
color
)
if
marker
is
None
:
marker
=
'none'
# Default.
if
not
isinstance
(
marker
,
MarkerStyle
):
self
.
_marker
=
MarkerStyle
(
marker
,
fillstyle
)
else
:
self
.
_marker
=
marker
self
.
_gapcolor
=
None
self
.
set_gapcolor
(
gapcolor
)
self
.
_markevery
=
None
self
.
_markersize
=
None
self
.
_antialiased
=
None
self
.
set_markevery
(
markevery
)
self
.
set_antialiased
(
antialiased
)
self
.
set_markersize
(
markersize
)
self
.
_markeredgecolor
=
None
self
.
_markeredgewidth
=
None
self
.
_markerfacecolor
=
None
self
.
_markerfacecoloralt
=
None
self
.
set_markerfacecolor
(
markerfacecolor
)
# Normalizes None to rc.
self
.
set_markerfacecoloralt
(
markerfacecoloralt
)
self
.
set_markeredgecolor
(
markeredgecolor
)
# Normalizes None to rc.
self
.
set_markeredgewidth
(
markeredgewidth
)
# update kwargs before updating data to give the caller a
# chance to init axes (and hence unit support)
self
.
_internal_update
(
kwargs
)
self
.
pickradius
=
pickradius
self
.
ind_offset
=
0
if
(
isinstance
(
self
.
_picker
,
Number
)
and
not
isinstance
(
self
.
_picker
,
bool
)):
self
.
_pickradius
=
self
.
_picker
self
.
_xorig
=
np
.
asarray
([])
self
.
_yorig
=
np
.
asarray
([])
self
.
_invalidx
=
True
self
.
_invalidy
=
True
self
.
_x
=
None
self
.
_y
=
None
self
.
_xy
=
None
self
.
_path
=
None
self
.
_transformed_path
=
None
self
.
_subslice
=
False
self
.
_x_filled
=
None
# used in subslicing; only x is needed
self
.
set_data
(
xdata
,
ydata
)
def
contains
(
self
,
mouseevent
):
"""
Test whether *mouseevent* occurred on the line.
An event is deemed to have occurred "on" the line if it is less
than ``self.pickradius`` (default: 5 points) away from it. Use
`~.Line2D.get_pickradius` or `~.Line2D.set_pickradius` to get or set
the pick radius.
Parameters
----------
mouseevent : `~matplotlib.backend_bases.MouseEvent`
Returns
-------
contains : bool
Whether any values are within the radius.
details : dict
A dictionary ``{'ind': pointlist}``, where *pointlist* is a
list of points of the line that are within the pickradius around
the event position.
TODO: sort returned indices by distance
"""
if
self
.
_different_canvas
(
mouseevent
):
return
False
, {}
# Make sure we have data to plot
if
self
.
_invalidy
or
self
.
_invalidx
:
self
.
recache
()
if
len
(
self
.
_xy
)
==
0
:
return
False
, {}
# Convert points to pixels
transformed_path
=
self
.
_get_transformed_path
()
path
,
affine
=
transformed_path
.
get_transformed_path_and_affine
()
path
=
affine
.
transform_path
(
path
)
xy
=
path
.
vertices
xt
=
xy
[:,
0
]
yt
=
xy
[:,
1
]
# Convert pick radius from points to pixels
fig
=
self
.
get_figure
(
root
=
True
)
if
fig
is
None
:
_log
.
warning
(
'no figure set when check if mouse is on line'
)
pixels
=
self
.
_pickradius
else
:
pixels
=
fig
.
dpi
/
72.
*
self
.
_pickradius
# The math involved in checking for containment (here and inside of
# segment_hits) assumes that it is OK to overflow, so temporarily set
# the error flags accordingly.
with
np
.
errstate
(
all
=
'ignore'
):
# Check for collision
if
self
.
_linestyle
in
[
'None'
,
None
]:
# If no line, return the nearby point(s)
ind
,
=
np
.
nonzero
(
(
xt
-
mouseevent
.
x
)
**
2
+
(
yt
-
mouseevent
.
y
)
**
2
<=
pixels
**
2
)
else
:
# If line, return the nearby segment(s)
ind
=
segment_hits
(
mouseevent
.
x
,
mouseevent
.
y
,
xt
,
yt
,
pixels
)
if
self
.
_drawstyle
.
startswith
(
"steps"
):
ind
//=
2
ind
+=
self
.
ind_offset
# Return the point(s) within radius
return
len
(
ind
)
>
0
,
dict
(
ind
=
ind
)
def
get_pickradius
(
self
):
"""
Return the pick radius used for containment tests.
See `.contains` for more details.
"""
return
self
.
_pickradius
def
set_pickradius
(
self
,
pickradius
):
"""
Set the pick radius used for containment tests.
See `.contains` for more details.
Parameters
----------
pickradius : float
Pick radius, in points.
"""
if
not
isinstance
(
pickradius
,
Real
)
or
pickradius
<
0
:
raise
ValueError
(
"pick radius should be a distance"
)
self
.
_pickradius
=
pickradius
pickradius
=
property
(
get_pickradius
,
set_pickradius
)
def
get_fillstyle
(
self
):
"""
Return the marker fill style.
See also `~.Line2D.set_fillstyle`.
"""
return
self
.
_marker
.
get_fillstyle
()
def
set_fillstyle
(
self
,
fs
):
"""
Set the marker fill style.
Parameters
----------
fs : {'full', 'left', 'right', 'bottom', 'top', 'none'}
Possible values:
- 'full': Fill the whole marker with the *markerfacecolor*.
- 'left', 'right', 'bottom', 'top': Fill the marker half at
the given side with the *markerfacecolor*. The other
half of the marker is filled with *markerfacecoloralt*.
- 'none': No filling.
For examples see :ref:`marker_fill_styles`.
"""
self
.
set_marker
(
MarkerStyle
(
self
.
_marker
.
get_marker
(),
fs
))
self
.
stale
=
True
def
set_markevery
(
self
,
every
):
"""
Set the markevery property to subsample the plot when using markers.
e.g., if ``every=5``, every 5-th marker will be plotted.
Parameters
----------
every : None or int or (int, int) or slice or list[int] or float or
\
(float, float) or list[bool]
Which markers to plot.
- ``every=None``: every point will be plotted.
- ``every=N``: every N-th marker will be plotted starting with
marker 0.
- ``every=(start, N)``: every N-th marker, starting at index
*start*, will be plotted.
- ``every=slice(start, end, N)``: every N-th marker, starting at
index *start*, up to but not including index *end*, will be
plotted.
- ``every=[i, j, m, ...]``: only markers at the given indices
will be plotted.
- ``every=[True, False, True, ...]``: only positions that are True
will be plotted. The list must have the same length as the data
points.
- ``every=0.1``, (i.e. a float): markers will be spaced at
approximately equal visual distances along the line; the distance
along the line between markers is determined by multiplying the
display-coordinate distance of the Axes bounding-box diagonal
by the value of *every*.
- ``every=(0.5, 0.1)`` (i.e. a length-2 tuple of float): similar
to ``every=0.1`` but the first marker will be offset along the
line by 0.5 multiplied by the
display-coordinate-diagonal-distance along the line.
For examples see
:doc:`/gallery/lines_bars_and_markers/markevery_demo`.
Notes
-----
Setting *markevery* will still only draw markers at actual data points.
While the float argument form aims for uniform visual spacing, it has
to coerce from the ideal spacing along the drawn line to the nearest
available data point. Depending on the number and distribution of data
points, and on how jagged the line is, the result may still not look
evenly spaced along the x- or y-axis.
When using a start offset to specify the first marker, the offset will
be from the first data point which may be different from the first
the visible data point if the plot is zoomed in.
If zooming in on a plot when using float arguments then the actual
data points that have markers will change because the distance between
markers is always determined from the display-coordinates
axes-bounding-box-diagonal regardless of the actual axes data limits.
"""
self
.
_markevery
=
every
self
.
stale
=
True
def
get_markevery
(
self
):
"""
Return the markevery setting for marker subsampling.
See also `~.Line2D.set_markevery`.
"""
return
self
.
_markevery
def
set_picker
(
self
,
p
):
"""
Set the event picker details for the line.
Parameters
----------
p : float or callable[[Artist, Event], tuple[bool, dict]]
If a float, it is used as the pick radius in points.
"""
if
not
callable
(
p
):
self
.
set_pickradius
(
p
)
self
.
_picker
=
p
def
get_bbox
(
self
):
"""Get the bounding box of this line."""
bbox
=
Bbox
([[
0
,
0
], [
0
,
0
]])
bbox
.
update_from_data_xy
(
self
.
get_xydata
())
return
bbox
def
get_window_extent
(
self
,
renderer
=
None
):
bbox
=
Bbox
([[
0
,
0
], [
0
,
0
]])
trans_data_to_xy
=
self
.
get_transform
().
transform
bbox
.
update_from_data_xy
(
trans_data_to_xy
(
self
.
get_xydata
()),
ignore
=
True
)
# correct for marker size, if any
if
self
.
_marker
:
ms
=
(
self
.
_markersize
/
72.0
*
self
.
get_figure
(
root
=
True
).
dpi
)
*
0.5
bbox
=
bbox
.
padded
(
ms
)
return
bbox
def
set_data
(
self
,
*
args
):
"""
Set the x and y data.
Parameters
----------
*args : (2, N) array or two 1D arrays
See Also
--------
set_xdata
set_ydata
"""
if
len
(
args
)
==
1
:
(
x
,
y
),
=
args
else
:
x
,
y
=
args
self
.
set_xdata
(
x
)
self
.
set_ydata
(
y
)
@
_api
.
deprecated
(
"3.12"
,
alternative
=
"recache(always=True)"
)
def
recache_always
(
self
):
self
.
recache
(
always
=
True
)
def
recache
(
self
,
always
=
False
):
if
always
or
self
.
_invalidx
:
xconv
=
self
.
convert_xunits
(
self
.
_xorig
)
x
=
_to_unmasked_float_array
(
xconv
).
ravel
()
else
:
x
=
self
.
_x
if
always
or
self
.
_invalidy
:
yconv
=
self
.
convert_yunits
(
self
.
_yorig
)
y
=
_to_unmasked_float_array
(
yconv
).
ravel
()
else
:
y
=
self
.
_y
self
.
_xy
=
np
.
column_stack
(
np
.
broadcast_arrays
(
x
,
y
)).
astype
(
float
)
self
.
_x
=
self
.
_xy
[:,
0
]
# views of the x and y data
self
.
_y
=
self
.
_xy
[:,
1
]
self
.
_subslice
=
False
if
(
self
.
axes
and
len
(
x
)
>
self
.
_subslice_optim_min_size
and
_path
.
is_sorted_and_has_non_nan
(
x
)
and
self
.
axes
.
name
==
'rectilinear'
and
self
.
axes
.
get_xscale
()
==
'linear'
and
self
.
_markevery
is
None
and
self
.
get_clip_on
()
and
self
.
get_transform
()
==
self
.
axes
.
transData
):
self
.
_subslice
=
True
nanmask
=
np
.
isnan
(
x
)
if
nanmask
.
any
():
self
.
_x_filled
=
self
.
_x
.
copy
()
indices
=
np
.
arange
(
len
(
x
))
self
.
_x_filled
[
nanmask
]
=
np
.
interp
(
indices
[
nanmask
],
indices
[
~
nanmask
],
self
.
_x
[
~
nanmask
])
else
:
self
.
_x_filled
=
self
.
_x
if
self
.
_path
is
not
None
:
interpolation_steps
=
self
.
_path
.
_interpolation_steps
else
:
interpolation_steps
=
1
if
self
.
_drawstyle
==
'default'
:
vertices
=
self
.
_xy
else
:
step_func
=
STEP_LOOKUP_MAP
[
self
.
_drawstyle
]
vertices
=
np
.
asarray
(
step_func
(
*
self
.
_xy
.
T
)).
T
self
.
_path
=
Path
(
vertices
,
_interpolation_steps
=
interpolation_steps
)
self
.
_transformed_path
=
None
self
.
_invalidx
=
False
self
.
_invalidy
=
False
def
_transform_path
(
self
,
subslice
=
None
):
"""
Put a TransformedPath instance at self._transformed_path;
all invalidation of the transform is then handled by the
TransformedPath instance.
"""
# Masked arrays are now handled by the Path class itself
if
subslice
is
not
None
:
if
self
.
_drawstyle
==
'default'
:
vertices
=
self
.
_xy
[
subslice
]
else
:
step_func
=
STEP_LOOKUP_MAP
[
self
.
_drawstyle
]
vertices
=
np
.
asarray
(
step_func
(
*
self
.
_xy
[
subslice
, :].
T
)).
T
_path
=
Path
(
vertices
,
_interpolation_steps
=
self
.
_path
.
_interpolation_steps
)
else
:
_path
=
self
.
_path
self
.
_transformed_path
=
TransformedPath
(
_path
,
self
.
get_transform
())
def
_get_transformed_path
(
self
):
"""Return this line's `~matplotlib.transforms.TransformedPath`."""
if
self
.
_transformed_path
is
None
:
self
.
_transform_path
()
return
self
.
_transformed_path
def
set_transform
(
self
,
t
):
# docstring inherited
self
.
_invalidx
=
True
self
.
_invalidy
=
True
super
().
set_transform
(
t
)
@
allow_rasterization
def
draw
(
self
,
renderer
):
# docstring inherited
if
not
self
.
get_visible
():
return
if
self
.
_invalidy
or
self
.
_invalidx
:
self
.
recache
()
self
.
ind_offset
=
0
# Needed for contains() method.
if
self
.
_subslice
and
self
.
axes
:
x0
,
x1
=
self
.
axes
.
get_xbound
()
i0
=
self
.
_x_filled
.
searchsorted
(
x0
,
'left'
)
i1
=
self
.
_x_filled
.
searchsorted
(
x1
,
'right'
)
subslice
=
slice
(
max
(
i0
-
1
,
0
),
i1
+
1
)
self
.
ind_offset
=
subslice
.
start
self
.
_transform_path
(
subslice
)
else
:
subslice
=
None
if
self
.
get_path_effects
():
from
matplotlib
.
patheffects
import
PathEffectRenderer
renderer
=
PathEffectRenderer
(
self
.
get_path_effects
(),
renderer
)
renderer
.
open_group
(
'line2d'
,
self
.
get_gid
())
if
self
.
_lineStyles
[
self
.
_linestyle
]
!=
'_draw_nothing'
:
tpath
,
affine
=
(
self
.
_get_transformed_path
()
.
get_transformed_path_and_affine
())
if
len
(
tpath
.
vertices
):
gc
=
renderer
.
new_gc
()
self
.
_set_gc_clip
(
gc
)
gc
.
set_url
(
self
.
get_url
())
gc
.
set_blend_mode
(
self
.
get_blend_mode
())
gc
.
set_antialiased
(
self
.
_antialiased
)
gc
.
set_linewidth
(
self
.
_linewidth
)
if
self
.
is_dashed
():
cap
=
self
.
_dashcapstyle
join
=
self
.
_dashjoinstyle
else
:
cap
=
self
.
_solidcapstyle
join
=
self
.
_solidjoinstyle
gc
.
set_joinstyle
(
join
)
gc
.
set_capstyle
(
cap
)
gc
.
set_snap
(
self
.
get_snap
())
if
self
.
get_sketch_params
()
is
not
None
:
gc
.
set_sketch_params
(
*
self
.
get_sketch_params
())
# We first draw a path within the gaps if needed, but only for
# visible dashed lines; zero-width lines would otherwise yield
# all-zero dashes.
if
(
self
.
_linewidth
>
0
and
self
.
is_dashed
()
and
self
.
_gapcolor
is
not
None
):
lc_rgba
=
mcolors
.
to_rgba
(
self
.
_gapcolor
,
self
.
_alpha
)
gc
.
set_foreground
(
lc_rgba
,
isRGBA
=
True
)
offset_gaps
,
gaps
=
_get_inverse_dash_pattern
(
*
self
.
_dash_pattern
)
gc
.
set_dashes
(
offset_gaps
,
gaps
)
renderer
.
draw_path
(
gc
,
tpath
,
affine
.
frozen
())
lc_rgba
=
mcolors
.
to_rgba
(
self
.
_color
,
self
.
_alpha
)
gc
.
set_foreground
(
lc_rgba
,
isRGBA
=
True
)
if
self
.
_linewidth
>
0
:
gc
.
set_dashes
(
*
self
.
_dash_pattern
)
else
:
gc
.
set_dashes
(
0
,
None
)
renderer
.
draw_path
(
gc
,
tpath
,
affine
.
frozen
())
gc
.
restore
()
if
self
.
_marker
and
self
.
_markersize
>
0
:
gc
=
renderer
.
new_gc
()
self
.
_set_gc_clip
(
gc
)
gc
.
set_url
(
self
.
get_url
())
gc
.
set_blend_mode
(
self
.
get_blend_mode
())
gc
.
set_linewidth
(
self
.
_markeredgewidth
)
gc
.
set_antialiased
(
self
.
_antialiased
)
ec_rgba
=
mcolors
.
to_rgba
(
self
.
get_markeredgecolor
(),
self
.
_alpha
)
fc_rgba
=
mcolors
.
to_rgba
(
self
.
_get_markerfacecolor
(),
self
.
_alpha
)
fcalt_rgba
=
mcolors
.
to_rgba
(
self
.
_get_markerfacecolor
(
alt
=
True
),
self
.
_alpha
)
# If the edgecolor is "auto", it is set according to the *line*
# color but inherits the alpha value of the *face* color, if any.
if
(
cbook
.
_str_equal
(
self
.
_markeredgecolor
,
"auto"
)
and
not
cbook
.
_str_lower_equal
(
self
.
get_markerfacecolor
(),
"none"
)):
ec_rgba
=
ec_rgba
[:
3
]
+
(
fc_rgba
[
3
],)
gc
.
set_foreground
(
ec_rgba
,
isRGBA
=
True
)
if
self
.
get_sketch_params
()
is
not
None
:
scale
,
length
,
randomness
=
self
.
get_sketch_params
()
gc
.
set_sketch_params
(
scale
/
2
,
length
/
2
,
2
*
randomness
)
marker
=
self
.
_marker
# Markers *must* be drawn ignoring the drawstyle (but don't pay the
# recaching if drawstyle is already "default").
if
self
.
get_drawstyle
()
!=
"default"
:
with
cbook
.
_setattr_cm
(
self
,
_drawstyle
=
"default"
,
_transformed_path
=
None
):
self
.
recache
()
self
.
_transform_path
(
subslice
)
tpath
,
affine
=
(
self
.
_get_transformed_path
()
.
get_transformed_points_and_affine
())
else
:
tpath
,
affine
=
(
self
.
_get_transformed_path
()
.
get_transformed_points_and_affine
())
if
len
(
tpath
.
vertices
):
# subsample the markers if markevery is not None
markevery
=
self
.
get_markevery
()
if
markevery
is
not
None
:
subsampled
=
_mark_every_path
(
markevery
,
tpath
,
affine
,
self
.
axes
)
else
:
subsampled
=
tpath
snap
=
marker
.
get_snap_threshold
()
if
isinstance
(
snap
,
Real
):
snap
=
renderer
.
points_to_pixels
(
self
.
_markersize
)
>=
snap
gc
.
set_snap
(
snap
)
gc
.
set_joinstyle
(
marker
.
get_joinstyle
())
gc
.
set_capstyle
(
marker
.
get_capstyle
())
marker_path
=
marker
.
get_path
()
marker_trans
=
marker
.
get_transform
()
w
=
renderer
.
points_to_pixels
(
self
.
_markersize
)
if
cbook
.
_str_equal
(
marker
.
get_marker
(),
","
):
gc
.
set_linewidth
(
0
)
else
:
# Don't scale for pixels, and don't stroke them
marker_trans
=
marker_trans
.
scale
(
w
)
renderer
.
draw_markers
(
gc
,
marker_path
,
marker_trans
,
subsampled
,
affine
.
frozen
(),
fc_rgba
)
alt_marker_path
=
marker
.
get_alt_path
()
if
alt_marker_path
:
alt_marker_trans
=
marker
.
get_alt_transform
()
alt_marker_trans
=
alt_marker_trans
.
scale
(
w
)
renderer
.
draw_markers
(
gc
,
alt_marker_path
,
alt_marker_trans
,
subsampled
,
affine
.
frozen
(),
fcalt_rgba
)
gc
.
restore
()
renderer
.
close_group
(
'line2d'
)
self
.
stale
=
False
def
get_antialiased
(
self
):
"""Return whether antialiased rendering is used."""
return
self
.
_antialiased
def
get_color
(
self
):
"""
Return the line color.
See also `~.Line2D.set_color`.
"""
return
self
.
_color
def
get_drawstyle
(
self
):
"""
Return the drawstyle.
See also `~.Line2D.set_drawstyle`.
"""
return
self
.
_drawstyle
def
get_gapcolor
(
self
):
"""
Return the line gapcolor.
See also `~.Line2D.set_gapcolor`.
"""
return
self
.
_gapcolor
def
get_linestyle
(
self
):
"""
Return the linestyle.
See also `~.Line2D.set_linestyle`.
"""
return
self
.
_linestyle
def
get_linewidth
(
self
):
"""
Return the linewidth in points.
See also `~.Line2D.set_linewidth`.
"""
return
self
.
_linewidth
def
get_marker
(
self
):
"""
Return the line marker.
See also `~.Line2D.set_marker`.
"""
return
self
.
_marker
.
get_marker
()
def
get_markeredgecolor
(
self
):
"""
Return the marker edge color.
See also `~.Line2D.set_markeredgecolor`.
"""
mec
=
self
.
_markeredgecolor
if
cbook
.
_str_equal
(
mec
,
'auto'
):
if
mpl
.
rcParams
[
'_internal.classic_mode'
]:
if
self
.
_marker
.
get_marker
()
in
(
'.'
,
','
):
return
self
.
_color
if
(
self
.
_marker
.
is_filled
()
and
self
.
_marker
.
get_fillstyle
()
!=
'none'
):
return
'k'
# Bad hard-wired default...
return
self
.
_color
else
:
return
mec
View remainder of file in raw view
Back
|
FazBrowse Home
|
New Git URL