-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathannotation.py
More file actions
433 lines (404 loc) · 14 KB
/
annotation.py
File metadata and controls
433 lines (404 loc) · 14 KB
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
# -*- coding: utf-8 -*-
#
# Licensed under the terms of the BSD 3-Clause
# (see plotpy/LICENSE for details)
# pylint: disable=C0103
"""
Annotation Item builder
-----------------------
This module provides a set of factory functions to simplify the creation
of annotation items.
"""
# Note: when adding method to builder classes, please do not forget to update the
# documentation (see builder.rst file). Because of class inheritance, the methods
# are not automatically documented (otherwise, they would be sorted alphabetically,
# due to a limitation of sphinx auto-doc).
from __future__ import annotations
import numpy as np
from plotpy.config import _
from plotpy.items import (
AnnotatedCircle,
AnnotatedEllipse,
AnnotatedPoint,
AnnotatedPolygon,
AnnotatedRectangle,
AnnotatedSegment,
)
from plotpy.styles import AnnotationParam
class AnnotationBuilder:
"""Class regrouping a set of factory functions to simplify the creation
of annotation items."""
def __get_annotationparam(
self,
title: str | None = None,
subtitle: str | None = None,
show_label: bool | None = None,
show_computations: bool | None = None,
show_subtitle: bool | None = None,
format: str | None = None,
uncertainty: float | None = None,
transform_matrix: np.ndarray | None = None,
readonly: bool | None = None,
private: bool | None = None,
) -> AnnotationParam:
param = AnnotationParam(_("Annotation"), icon="annotation.png")
if title is not None:
param.title = title
if subtitle is not None:
param.subtitle = subtitle
if show_label is not None:
param.show_label = show_label
if show_computations is not None:
param.show_computations = show_computations
if show_subtitle is not None:
param.show_subtitle = show_subtitle
if format is not None:
param.format = format
if uncertainty is not None:
param.uncertainty = uncertainty
if transform_matrix is not None:
param.transform_matrix = transform_matrix
if readonly is not None:
param.readonly = readonly
if private is not None:
param.private = private
return param
def annotated_point(
self,
x: float,
y: float,
title: str | None = None,
subtitle: str | None = None,
show_label: bool | None = None,
show_computations: bool | None = None,
show_subtitle: bool | None = None,
format: str | None = None,
uncertainty: float | None = None,
transform_matrix: np.ndarray | None = None,
readonly: bool | None = None,
private: bool | None = None,
) -> AnnotatedPoint:
"""Make an annotated point `plot item`
Args:
x: point x coordinate
y: point y coordinate
title: label name. Default is None
subtitle: label subtitle. Default is None
show_label: show label. Default is None
show_computations: show computations. Default is None
show_subtitle: show subtitle. Default is None
format: string formatting. Default is None
uncertainty: measurement relative uncertainty. Default is None
transform_matrix: transform matrix. Default is None
readonly: readonly. Default is None
private: private. Default is None
Returns:
:py:class:`.AnnotatedPoint` object
"""
param = self.__get_annotationparam(
title=title,
subtitle=subtitle,
show_label=show_label,
show_computations=show_computations,
show_subtitle=show_subtitle,
format=format,
uncertainty=uncertainty,
transform_matrix=transform_matrix,
readonly=readonly,
private=private,
)
shape = AnnotatedPoint(x, y, param)
shape.set_style("plot", "shape/drag")
return shape
def __annotated_shape(
self,
shapeclass,
points,
title,
subtitle,
show_label,
show_computations,
show_subtitle,
format,
uncertainty,
transform_matrix,
readonly,
private,
):
param = self.__get_annotationparam(
title=title,
subtitle=subtitle,
show_label=show_label,
show_computations=show_computations,
show_subtitle=show_subtitle,
format=format,
uncertainty=uncertainty,
transform_matrix=transform_matrix,
readonly=readonly,
private=private,
)
if isinstance(points, np.ndarray):
shape = shapeclass(points, annotationparam=param)
else:
shape = shapeclass(*points, annotationparam=param)
shape.set_style("plot", "shape/drag")
return shape
def annotated_rectangle(
self,
x0: float,
y0: float,
x1: float,
y1: float,
title: str | None = None,
subtitle: str | None = None,
show_label: bool | None = None,
show_computations: bool | None = None,
show_subtitle: bool | None = None,
format: str | None = None,
uncertainty: float | None = None,
transform_matrix: np.ndarray | None = None,
readonly: bool | None = None,
private: bool | None = None,
) -> AnnotatedRectangle:
"""Make an annotated rectangle `plot item`
Args:
x0: rectangle x0 coordinate
y0: rectangle y0 coordinate
x1: rectangle x1 coordinate
y1: rectangle y1 coordinate
title: label name. Default is None
subtitle: label subtitle. Default is None
show_label: show label. Default is None
show_computations: show computations. Default is None
show_subtitle: show subtitle. Default is None
format: string formatting. Default is None
uncertainty: measurement relative uncertainty. Default is None
transform_matrix: transform matrix. Default is None
readonly: readonly. Default is None
private: private. Default is None
Returns:
:py:class:`.AnnotatedRectangle` object
"""
points = x0, y0, x1, y1
return self.__annotated_shape(
AnnotatedRectangle,
points,
title,
subtitle,
show_label,
show_computations,
show_subtitle,
format,
uncertainty,
transform_matrix,
readonly,
private,
)
def annotated_ellipse(
self,
x0: float,
y0: float,
x1: float,
y1: float,
x2: float | None = None,
y2: float | None = None,
x3: float | None = None,
y3: float | None = None,
title: str | None = None,
subtitle: str | None = None,
show_label: bool | None = None,
show_computations: bool | None = None,
show_subtitle: bool | None = None,
format: str | None = None,
uncertainty: float | None = None,
transform_matrix: np.ndarray | None = None,
readonly: bool | None = None,
private: bool | None = None,
) -> AnnotatedEllipse:
"""Make an annotated ellipse `plot item`
Args:
x0: ellipse x0 coordinate
y0: ellipse y0 coordinate
x1: ellipse x1 coordinate
y1: ellipse y1 coordinate
x2: ellipse x2 coordinate. Default is None
y2: ellipse y2 coordinate. Default is None
x3: ellipse x3 coordinate. Default is None
y3: ellipse y3 coordinate. Default is None
title: label name. Default is None
subtitle: label subtitle. Default is None
show_label: show label. Default is None
show_computations: show computations. Default is None
show_subtitle: show subtitle. Default is None
format: string formatting. Default is None
uncertainty: measurement relative uncertainty. Default is None
transform_matrix: transform matrix. Default is None
readonly: readonly. Default is None
private: private. Default is None
Returns:
:py:class:`.AnnotatedEllipse` object
"""
points = x0, y0, x1, y1
item = self.__annotated_shape(
AnnotatedEllipse,
points,
title,
subtitle,
show_label,
show_computations,
show_subtitle,
format,
uncertainty,
transform_matrix,
readonly,
private,
)
if x2 is not None and y2 is not None and x3 is not None and y3 is not None:
item.set_ydiameter(x2, y2, x3, y3)
return item
def annotated_circle(
self,
x0: float,
y0: float,
x1: float,
y1: float,
title: str | None = None,
subtitle: str | None = None,
show_label: bool | None = None,
show_computations: bool | None = None,
show_subtitle: bool | None = None,
format: str | None = None,
uncertainty: float | None = None,
transform_matrix: np.ndarray | None = None,
readonly: bool | None = None,
private: bool | None = None,
) -> AnnotatedCircle:
"""Make an annotated circle `plot item`
Args:
x0: circle x0 coordinate
y0: circle y0 coordinate
x1: circle x1 coordinate
y1: circle y1 coordinate
title: label name. Default is None
subtitle: label subtitle. Default is None
show_label: show label. Default is None
show_computations: show computations. Default is None
show_subtitle: show subtitle. Default is None
format: string formatting. Default is None
uncertainty: measurement relative uncertainty. Default is None
transform_matrix: transform matrix. Default is None
readonly: readonly. Default is None
private: private. Default is None
Returns:
:py:class:`.AnnotatedCircle` object
"""
points = x0, y0, x1, y1
return self.__annotated_shape(
AnnotatedCircle,
points,
title,
subtitle,
show_label,
show_computations,
show_subtitle,
format,
uncertainty,
transform_matrix,
readonly,
private,
)
def annotated_segment(
self,
x0: float,
y0: float,
x1: float,
y1: float,
title: str | None = None,
subtitle: str | None = None,
show_label: bool | None = None,
show_computations: bool | None = None,
show_subtitle: bool | None = None,
format: str | None = None,
uncertainty: float | None = None,
transform_matrix: np.ndarray | None = None,
readonly: bool | None = None,
private: bool | None = None,
) -> AnnotatedSegment:
"""Make an annotated segment `plot item`
Args:
x0: segment x0 coordinate
y0: segment y0 coordinate
x1: segment x1 coordinate
y1: segment y1 coordinate
title: label name. Default is None
subtitle: label subtitle. Default is None
show_label: show label. Default is None
show_computations: show computations. Default is None
show_subtitle: show subtitle. Default is None
format: string formatting. Default is None
uncertainty: measurement relative uncertainty. Default is None
transform_matrix: transform matrix. Default is None
readonly: readonly. Default is None
private: private. Default is None
Returns:
:py:class:`.AnnotatedSegment` object
"""
points = x0, y0, x1, y1
return self.__annotated_shape(
AnnotatedSegment,
points,
title,
subtitle,
show_label,
show_computations,
show_subtitle,
format,
uncertainty,
transform_matrix,
readonly,
private,
)
def annotated_polygon(
self,
points: np.ndarray,
title: str | None = None,
subtitle: str | None = None,
show_label: bool | None = None,
show_computations: bool | None = None,
show_subtitle: bool | None = None,
format: str | None = None,
uncertainty: float | None = None,
transform_matrix: np.ndarray | None = None,
readonly: bool | None = None,
private: bool | None = None,
) -> AnnotatedPolygon:
"""Make an annotated polygon `plot item`
Args:
points: polygon points
title: label name. Default is None
subtitle: label subtitle. Default is None
show_label: show label. Default is None
show_computations: show computations. Default is None
show_subtitle: show subtitle. Default is None
format: string formatting. Default is None
uncertainty: measurement relative uncertainty. Default is None
transform_matrix: transform matrix. Default is None
readonly: readonly. Default is None
private: private. Default is None
Returns:
:py:class:`.AnnotatedPolygon` object
"""
return self.__annotated_shape(
AnnotatedPolygon,
points,
title,
subtitle,
show_label,
show_computations,
show_subtitle,
format,
uncertainty,
transform_matrix,
readonly,
private,
)