Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
matplotlib/examples/misc/cursor_demo.py at v3.4.x · matplotlib/matplotlib · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
matplotlib
/
matplotlib
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
8.5k
Star
23.2k
Code
Issues
1.1k
Pull requests
423
Actions
Projects
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Files
Expand file tree
v3.4.x
Breadcrumbs
matplotlib
/
examples
/
misc
/
cursor_demo.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
219 lines (185 loc) · 7.76 KB
v3.4.x
Breadcrumbs
matplotlib
/
examples
/
misc
/
cursor_demo.py
Copy path
Top
File metadata and controls
Code
Blame
219 lines (185 loc) · 7.76 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
"""
=================
Cross hair cursor
=================
This example adds a cross hair as a data cursor. The cross hair is
implemented as regular line objects that are updated on mouse move.
We show three implementations:
1) A simple cursor implementation that redraws the figure on every mouse move.
This is a bit slow and you may notice some lag of the cross hair movement.
2) A cursor that uses blitting for speedup of the rendering.
3) A cursor that snaps to data points.
Faster cursoring is possible using native GUI drawing, as in
:doc:`/gallery/user_interfaces/wxcursor_demo_sgskip`.
The mpldatacursor__ and mplcursors__ third-party packages can be used to
achieve a similar effect.
__ https://github.com/joferkington/mpldatacursor
__ https://github.com/anntzer/mplcursors
"""
import
matplotlib
.
pyplot
as
plt
import
numpy
as
np
class
Cursor
:
"""
A cross hair cursor.
"""
def
__init__
(
self
,
ax
):
self
.
ax
=
ax
self
.
horizontal_line
=
ax
.
axhline
(
color
=
'k'
,
lw
=
0.8
,
ls
=
'--'
)
self
.
vertical_line
=
ax
.
axvline
(
color
=
'k'
,
lw
=
0.8
,
ls
=
'--'
)
# text location in axes coordinates
self
.
text
=
ax
.
text
(
0.72
,
0.9
,
''
,
transform
=
ax
.
transAxes
)
def
set_cross_hair_visible
(
self
,
visible
):
need_redraw
=
self
.
horizontal_line
.
get_visible
()
!=
visible
self
.
horizontal_line
.
set_visible
(
visible
)
self
.
vertical_line
.
set_visible
(
visible
)
self
.
text
.
set_visible
(
visible
)
return
need_redraw
def
on_mouse_move
(
self
,
event
):
if
not
event
.
inaxes
:
need_redraw
=
self
.
set_cross_hair_visible
(
False
)
if
need_redraw
:
self
.
ax
.
figure
.
canvas
.
draw
()
else
:
self
.
set_cross_hair_visible
(
True
)
x
,
y
=
event
.
xdata
,
event
.
ydata
# update the line positions
self
.
horizontal_line
.
set_ydata
(
y
)
self
.
vertical_line
.
set_xdata
(
x
)
self
.
text
.
set_text
(
'x=%1.2f, y=%1.2f'
%
(
x
,
y
))
self
.
ax
.
figure
.
canvas
.
draw
()
x
=
np
.
arange
(
0
,
1
,
0.01
)
y
=
np
.
sin
(
2
*
2
*
np
.
pi
*
x
)
fig
,
ax
=
plt
.
subplots
()
ax
.
set_title
(
'Simple cursor'
)
ax
.
plot
(
x
,
y
,
'o'
)
cursor
=
Cursor
(
ax
)
fig
.
canvas
.
mpl_connect
(
'motion_notify_event'
,
cursor
.
on_mouse_move
)
##############################################################################
# Faster redrawing using blitting
# """""""""""""""""""""""""""""""
# This technique stores the rendered plot as a background image. Only the
# changed artists (cross hair lines and text) are rendered anew. They are
# combined with the background using blitting.
#
# This technique is significantly faster. It requires a bit more setup because
# the background has to be stored without the cross hair lines (see
# ``create_new_background()``). Additionally, a new background has to be
# created whenever the figure changes. This is achieved by connecting to the
# ``'draw_event'``.
class
BlittedCursor
:
"""
A cross hair cursor using blitting for faster redraw.
"""
def
__init__
(
self
,
ax
):
self
.
ax
=
ax
self
.
background
=
None
self
.
horizontal_line
=
ax
.
axhline
(
color
=
'k'
,
lw
=
0.8
,
ls
=
'--'
)
self
.
vertical_line
=
ax
.
axvline
(
color
=
'k'
,
lw
=
0.8
,
ls
=
'--'
)
# text location in axes coordinates
self
.
text
=
ax
.
text
(
0.72
,
0.9
,
''
,
transform
=
ax
.
transAxes
)
self
.
_creating_background
=
False
ax
.
figure
.
canvas
.
mpl_connect
(
'draw_event'
,
self
.
on_draw
)
def
on_draw
(
self
,
event
):
self
.
create_new_background
()
def
set_cross_hair_visible
(
self
,
visible
):
need_redraw
=
self
.
horizontal_line
.
get_visible
()
!=
visible
self
.
horizontal_line
.
set_visible
(
visible
)
self
.
vertical_line
.
set_visible
(
visible
)
self
.
text
.
set_visible
(
visible
)
return
need_redraw
def
create_new_background
(
self
):
if
self
.
_creating_background
:
# discard calls triggered from within this function
return
self
.
_creating_background
=
True
self
.
set_cross_hair_visible
(
False
)
self
.
ax
.
figure
.
canvas
.
draw
()
self
.
background
=
self
.
ax
.
figure
.
canvas
.
copy_from_bbox
(
self
.
ax
.
bbox
)
self
.
set_cross_hair_visible
(
True
)
self
.
_creating_background
=
False
def
on_mouse_move
(
self
,
event
):
if
self
.
background
is
None
:
self
.
create_new_background
()
if
not
event
.
inaxes
:
need_redraw
=
self
.
set_cross_hair_visible
(
False
)
if
need_redraw
:
self
.
ax
.
figure
.
canvas
.
restore_region
(
self
.
background
)
self
.
ax
.
figure
.
canvas
.
blit
(
self
.
ax
.
bbox
)
else
:
self
.
set_cross_hair_visible
(
True
)
# update the line positions
x
,
y
=
event
.
xdata
,
event
.
ydata
self
.
horizontal_line
.
set_ydata
(
y
)
self
.
vertical_line
.
set_xdata
(
x
)
self
.
text
.
set_text
(
'x=%1.2f, y=%1.2f'
%
(
x
,
y
))
self
.
ax
.
figure
.
canvas
.
restore_region
(
self
.
background
)
self
.
ax
.
draw_artist
(
self
.
horizontal_line
)
self
.
ax
.
draw_artist
(
self
.
vertical_line
)
self
.
ax
.
draw_artist
(
self
.
text
)
self
.
ax
.
figure
.
canvas
.
blit
(
self
.
ax
.
bbox
)
x
=
np
.
arange
(
0
,
1
,
0.01
)
y
=
np
.
sin
(
2
*
2
*
np
.
pi
*
x
)
fig
,
ax
=
plt
.
subplots
()
ax
.
set_title
(
'Blitted cursor'
)
ax
.
plot
(
x
,
y
,
'o'
)
blitted_cursor
=
BlittedCursor
(
ax
)
fig
.
canvas
.
mpl_connect
(
'motion_notify_event'
,
blitted_cursor
.
on_mouse_move
)
##############################################################################
# Snapping to data points
# """""""""""""""""""""""
# The following cursor snaps its position to the data points of a `.Line2D`
# object.
#
# To save unnecessary redraws, the index of the last indicated data point is
# saved in ``self._last_index``. A redraw is only triggered when the mouse
# moves far enough so that another data point must be selected. This reduces
# the lag due to many redraws. Of course, blitting could still be added on top
# for additional speedup.
class
SnappingCursor
:
"""
A cross hair cursor that snaps to the data point of a line, which is
closest to the *x* position of the cursor.
For simplicity, this assumes that *x* values of the data are sorted.
"""
def
__init__
(
self
,
ax
,
line
):
self
.
ax
=
ax
self
.
horizontal_line
=
ax
.
axhline
(
color
=
'k'
,
lw
=
0.8
,
ls
=
'--'
)
self
.
vertical_line
=
ax
.
axvline
(
color
=
'k'
,
lw
=
0.8
,
ls
=
'--'
)
self
.
x
,
self
.
y
=
line
.
get_data
()
self
.
_last_index
=
None
# text location in axes coords
self
.
text
=
ax
.
text
(
0.72
,
0.9
,
''
,
transform
=
ax
.
transAxes
)
def
set_cross_hair_visible
(
self
,
visible
):
need_redraw
=
self
.
horizontal_line
.
get_visible
()
!=
visible
self
.
horizontal_line
.
set_visible
(
visible
)
self
.
vertical_line
.
set_visible
(
visible
)
self
.
text
.
set_visible
(
visible
)
return
need_redraw
def
on_mouse_move
(
self
,
event
):
if
not
event
.
inaxes
:
self
.
_last_index
=
None
need_redraw
=
self
.
set_cross_hair_visible
(
False
)
if
need_redraw
:
self
.
ax
.
figure
.
canvas
.
draw
()
else
:
self
.
set_cross_hair_visible
(
True
)
x
,
y
=
event
.
xdata
,
event
.
ydata
index
=
min
(
np
.
searchsorted
(
self
.
x
,
x
),
len
(
self
.
x
)
-
1
)
if
index
==
self
.
_last_index
:
return
# still on the same data point. Nothing to do.
self
.
_last_index
=
index
x
=
self
.
x
[
index
]
y
=
self
.
y
[
index
]
# update the line positions
self
.
horizontal_line
.
set_ydata
(
y
)
self
.
vertical_line
.
set_xdata
(
x
)
self
.
text
.
set_text
(
'x=%1.2f, y=%1.2f'
%
(
x
,
y
))
self
.
ax
.
figure
.
canvas
.
draw
()
x
=
np
.
arange
(
0
,
1
,
0.01
)
y
=
np
.
sin
(
2
*
2
*
np
.
pi
*
x
)
fig
,
ax
=
plt
.
subplots
()
ax
.
set_title
(
'Snapping cursor'
)
line
,
=
ax
.
plot
(
x
,
y
,
'o'
)
snap_cursor
=
SnappingCursor
(
ax
,
line
)
fig
.
canvas
.
mpl_connect
(
'motion_notify_event'
,
snap_cursor
.
on_mouse_move
)
plt
.
show
()
You can’t perform that action at this time.