-
Notifications
You must be signed in to change notification settings - Fork 0
/
annoplot.py
378 lines (318 loc) · 14.2 KB
/
annoplot.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
from typing import Optional, Union, Dict, List, Any
import datetime
import numpy as np
import matplotlib.pyplot as plt
import matplotlib.dates as mdates
from matplotlib.figure import Figure
from matplotlib.axis import Axis
AnnotationsType = Union[list, List[list], dict]
def _distance(x1: float, x2: float, y1: float, y2: float) -> float:
"""
return the Manhattan _distance between two points
@param x1: x position of point 1
@param x2: x position of point 2
@param y1: y position of point 1
@param y2: y position of point 2
@return: a float with the Manhattan distance
"""
return abs(x1 - x2) + abs(y1 - y2)
def annotate(annotations: Optional[AnnotationsType] = None, fig: Optional[Figure] = None,
annmarkerfacecolor: str = 'r', annfacecolor: str = 'w', annedgecolor: str = 'k'):
"""
Connects an Annotator to the given figure to show the given annotations
@param annotations: a list, a list of list or a dict containing the annotations. A list of lists is used if there
are multiple plots on the same axis, a dictionary if there are more axes. The keys of the dictionary must be the
axes and the values the annotations.
@param fig: the figure on which to show annotations. If None takes the last one opened. If there are no open
figures raises an error.
@param annmarkerfacecolor: the color of the marker
@param annfacecolor: the background color of the box
@param annedgecolor: the edge color of the box
"""
# If no figure is specified take the last one. We don't want to use plt.gcf() because if there are no open figures
# it opens a new empty one
if fig is None:
try:
fig = plt.figure(plt.get_fignums()[-1])
except IndexError:
raise (IndexError('There are no open figures'))
axes = fig.get_axes()
if type(annotations) is not dict:
if len(axes) == 1:
annotations = {axes[0]: annotations}
else:
raise (RuntimeError('If the figure has more than 1 axis you need to pass in a dictionary, mapping '
'each axis to the corresponding annotations'))
else:
if len(annotations) != len(axes):
for ax in axes:
if ax not in annotations:
annotations[ax] = []
antr = Annotator(annotations, fig, annmarkerfacecolor, annfacecolor, annedgecolor)
fig.canvas.mpl_connect('button_press_event', antr)
fig.canvas.mpl_connect('key_press_event', antr)
def _is_arraylike(x: Any) -> bool:
"""
Return True if the argument is a list, a tuple or a numpy array
@param x: a python variable
@return: True if the argument is a list, a tuple or a numpy array, else False
"""
if isinstance(x, (list, tuple, np.ndarray)):
return True
else:
return False
class Annotator:
"""
A class to show an annotation next to the point of a plot nearest to the click and move around with arrows.
The annotation will show the location of the point and, if the annotations parameter is passed and the plot is
a line, some additional information.
Right: next point
Left: previous point
Esc, Del: clear the current annotation box
@param annotations: a list, a list of list or a dict containing the annotations. A list of lists is used if
there are multiple plots on the same axis, a dictionary if there are more axes. The keys of the dictionary
must be the axes and the values the annotations. Works only with plots drawn with plt.plot
@param fig: the figure on which to show annotations
@param annmarkerfacecolor: the color of the marker
@param annfacecolor: the background color of the box
@param annedgecolor: the edge color of the box
"""
def __init__(self, annotations: AnnotationsType, fig: Figure,
annmarkerfacecolor: str, annfacecolor: str, annedgecolor: str):
self.annotations = annotations
self.fig = fig
self.annmarkerfacecolor = annmarkerfacecolor
self.annfacecolor = annfacecolor
self.annedgecolor = annedgecolor
self.drawn_annotation: Dict[Axis, Union[None, tuple]] = {}
self.shown: Dict[Axis, Union[None, tuple]] = {}
for ax in fig.get_axes():
self.shown[ax] = None
self.drawn_annotation[ax] = None
def __call__(self, event):
ax = event.inaxes
if ax is None:
ax = plt.gca()
click_x = event.xdata
click_y = event.ydata
if event.name == 'button_press_event' and (click_x is None or click_y is None):
return
xlim = ax.get_xlim()
ylim = ax.get_ylim()
x_range = xlim[1] - xlim[0]
y_range = ylim[1] - ylim[0]
arguments = [ax, click_x, click_y, x_range, y_range]
if len(ax.lines) > 0 and len(ax.images) == 0 and len(ax.patches) == 0:
# Annotations must be enclosed in a list so that there can be more annotated lines
arraylike_check = [_is_arraylike(x) for x in self.annotations[ax]]
if not np.all(arraylike_check):
self.annotations[ax] = [self.annotations[ax]]
self._manage_plot(event, arguments, 'line')
elif len(ax.lines) == 0 and len(ax.images) > 0 and len(ax.patches) == 0:
self._manage_plot(event, arguments, 'image')
elif len(ax.lines) == 0 and len(ax.images) == 0 and len(ax.patches) > 0:
self._manage_plot(event, arguments, 'patch')
else:
raise (RuntimeError('Annotations can only be added to an Axis that contains Lines, Images, '
'Histograms, Boxplots but not a mixture of them'))
def _manage_plot(self, event, arguments, plot_type):
"""
Manages the response to button and key press events
@param event: the nae of the event
@param arguments: the arguments in the order: axis, x position of the event, y position of the event,
x dimension of the axis, y dimension of the axis
@param plot_type: the type of the plot, can be line, image or patch
"""
ax, click_x, click_y, x_range, y_range = arguments
if event.name == 'button_press_event':
chosen_idx = None
annotation = None
data = self._get_iterable_data(ax, plot_type)
if plot_type == 'image':
click_x = np.round(click_x).astype(int)
click_y = np.round(click_y).astype(int)
chosen_idx = (click_x, click_y)
annotation = [click_x, click_y, None]
else:
min_dist = np.inf
for i, d in enumerate(data):
xdata = d[0]
ydata = d[1]
for j in range(len(xdata)):
x = xdata[j]
y = ydata[j]
if isinstance(x, datetime.datetime):
x = mdates.date2num(x)
if isinstance(y, datetime.datetime):
y = mdates.date2num(y)
dist = _distance(x / x_range, click_x / x_range, y / y_range, click_y / y_range)
if dist < min_dist:
try:
annotation = [x, y, self.annotations[ax][i][j]]
except IndexError:
annotation = [x, y, None]
min_dist = dist
chosen_idx = (i, j)
x, y, a = annotation
self._draw_annotation(ax, x, y, a)
self.shown[ax] = chosen_idx
elif event.name == 'key_press_event':
if self.shown[ax] is None:
return
i, j = self.shown[ax]
data = self._get_iterable_data(ax, plot_type)
res = self._manage_key_press(ax, data, i, j, event.key, plot_type)
if res is not None:
x, y, a = res
self._draw_annotation(ax, x, y, a)
def _manage_key_press(self, ax, data, i, j, key, plot_type) -> Union[None, tuple]:
"""
Manage the event of the user pressing a key
@param ax: the axis
@param data: the x and y positions
@param i: the x-index of the point to annotate
@param j: the y-index of the point to annotate
@param key: the key pressed
@param plot_type: the type of the plot, can be line, image or patch
@return: the x and y positions of the annotated plot and eventually the extra annotation to add
"""
x, y, a = (None, None, None)
if key == 'left':
if plot_type == 'image':
if i != 0:
x, y, a = (i - 1, j, None)
self.shown[ax] = (self.shown[ax][0] - 1, self.shown[ax][1])
else:
return None
else:
if j != 0:
x = data[i][0][j - 1]
y = data[i][1][j - 1]
try:
a = self.annotations[ax][i][j - 1]
except IndexError:
a = None
self.shown[ax] = (self.shown[ax][0], self.shown[ax][1] - 1)
else:
return None
elif key == 'right':
if plot_type == 'image':
if i < data[0][1] - 1: # max extent of horizontal axis
x, y, a = (i + 1, j, None)
self.shown[ax] = (self.shown[ax][0] + 1, self.shown[ax][1])
else:
return None
else:
if j != len(data[i][0]) - 1:
x = data[i][0][j + 1]
y = data[i][1][j + 1]
try:
a = self.annotations[ax][i][j + 1]
except IndexError:
a = None
self.shown[ax] = (self.shown[ax][0], self.shown[ax][1] + 1)
else:
return None
elif key == 'up':
if plot_type == 'image':
if j != 0:
x, y, a = (i, j - 1, None)
self.shown[ax] = (self.shown[ax][0], self.shown[ax][1] - 1)
else:
return None
else:
return None
elif key == 'down':
if plot_type == 'image':
if j < data[1][0] - 1: # max extent of vertical axis
x, y, a = (i, j + 1, None)
self.shown[ax] = (self.shown[ax][0], self.shown[ax][1] + 1)
else:
return None
else:
return None
elif key == 'escape' or key == 'backspace':
self._clear_annotation(ax)
return None
return x, y, a
def _get_iterable_data(self, ax, plot_type):
"""
Get the data to be iterated on, depending on the plot type
@param ax: the axis
@param plot_type: the type of the plot, can be line, image or patch
@return: the data tht can be iterated on to sequentially show the annotations
"""
data = None
if plot_type == 'line':
lines = ax.lines
data = [(line.get_xdata(), line.get_ydata()) for line in lines]
elif plot_type == 'image':
xdata = ax.get_xlim()
ydata = ax.get_ylim()
data = (xdata, ydata)
elif plot_type == 'patch':
n = len(ax.patches)
xdata = np.empty(n, dtype=float)
ydata = np.empty(n, dtype=float)
for i, p in enumerate(ax.patches):
bbox = p.get_bbox()
xdata[i] = (bbox.xmin + bbox.xmax) / 2
ydata[i] = bbox.ymax # (bbox.ymin + bbox.ymax) / 2
data = [(xdata, ydata)]
return data
def _draw_annotation(self, ax, x, y, annotation):
"""
Draws an annotation at the specified position in the specified axis
@param ax: the axis where to draw the annotation on
@param x: the x axis of the point
@param y: the y axis of the point
@param annotation: the additional text to display, beside the position of the point
"""
xlim = ax.get_xlim()
ylim = ax.get_ylim()
deltax = abs(xlim[1] - xlim[0]) / 50
deltay = abs(ylim[1] - ylim[0]) / 50
bkup_shown = self.shown[ax]
self._clear_annotation(ax)
self.shown[ax] = bkup_shown
if annotation is not None:
text = '{:.4f}, {:.4f}\n{}'.format(x, y, annotation)
else:
text = '{:.4f}, {:.4f}'.format(x, y)
t = ax.text(x + deltax, y + deltay, text,
bbox={'facecolor': self.annfacecolor, 'edgecolor': self.annedgecolor})
bb = t.get_window_extent(renderer=self.fig.canvas.renderer).transformed(ax.transData.inverted())
change = False
if ylim[0] > ylim[1]:
vlim = (ylim[1], ylim[0])
else:
vlim = ylim
# Adjust annotation box so that it does not go past the borders
final_pos_x = x + deltax
if final_pos_x + bb.width > xlim[1]:
final_pos_x -= (final_pos_x + bb.width - xlim[1])
change = True
final_pos_y = y + deltay
if final_pos_y + bb.height > vlim[1]:
final_pos_y -= (final_pos_y + bb.height - vlim[1])
change = True
if change:
t.remove()
t = ax.text(final_pos_x, final_pos_y, text,
bbox={'facecolor': self.annfacecolor, 'edgecolor': self.annedgecolor})
m = ax.scatter([x], [y], marker='s', c=self.annmarkerfacecolor, zorder=100)
self.drawn_annotation[ax] = (t, m)
ax.figure.canvas.draw_idle()
ax.set_xlim(xlim)
ax.set_ylim(ylim)
def _clear_annotation(self, ax):
"""
Clear all drawn annotations from the axis
@param ax: a matplotlib axis
"""
if self.drawn_annotation[ax] is not None:
self.drawn_annotation[ax][0].remove()
self.drawn_annotation[ax][1].remove()
self.shown[ax] = None
self.drawn_annotation[ax] = None
self.fig.canvas.draw_idle()