Repository navigation
Expand file tree
/
Copy patharraymodel.py
More file actions
580 lines (506 loc) · 21.2 KB
/
Copy patharraymodel.py
File metadata and controls
580 lines (506 loc) · 21.2 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
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
from os.path import basename
import logging
from inspect import stack
import numpy as np
from larray_editor.utils import (get_font, to_text_string,
is_float, is_number, LinearGradient, SUPPORTED_FORMATS, scale_to_01range,
Product, is_number_value, get_sample, get_sample_indices, logger)
from qtpy.QtCore import Qt, QModelIndex, QAbstractTableModel, Signal
from qtpy.QtGui import QColor
from qtpy.QtWidgets import QMessageBox
LARGE_SIZE = 5e5
LARGE_NROWS = 1e5
LARGE_COLS = 60
class AbstractArrayModel(QAbstractTableModel):
"""Labels Table Model.
Parameters
----------
parent : QWidget, optional
Parent Widget.
readonly : bool, optional
If True, data cannot be changed. False by default.
font : QFont, optional
Font. Default is `Calibri` with size 11.
"""
ROWS_TO_LOAD = 500
COLS_TO_LOAD = 40
def __init__(self, parent=None, readonly=False, font=None):
QAbstractTableModel.__init__(self)
self.dialog = parent
self.readonly = readonly
if font is None:
font = get_font("arreditor")
self.font = font
self._data = None
self.rows_loaded = 0
self.cols_loaded = 0
self.total_rows = 0
self.total_cols = 0
def _set_data(self, data):
raise NotImplementedError()
def set_data(self, data, reset=True):
self._set_data(data)
if reset:
self.reset()
def rowCount(self, parent=QModelIndex()):
return self.rows_loaded
def columnCount(self, parent=QModelIndex()):
return self.cols_loaded
def fetch_more_rows(self):
if self.total_rows > self.rows_loaded:
remainder = self.total_rows - self.rows_loaded
items_to_fetch = min(remainder, self.ROWS_TO_LOAD)
self.beginInsertRows(QModelIndex(), self.rows_loaded,
self.rows_loaded + items_to_fetch - 1)
self.rows_loaded += items_to_fetch
self.endInsertRows()
def fetch_more_columns(self):
if self.total_cols > self.cols_loaded:
remainder = self.total_cols - self.cols_loaded
items_to_fetch = min(remainder, self.COLS_TO_LOAD)
self.beginInsertColumns(QModelIndex(), self.cols_loaded,
self.cols_loaded + items_to_fetch - 1)
self.cols_loaded += items_to_fetch
self.endInsertColumns()
def get_value(self, index):
raise NotImplementedError()
def _compute_rows_cols_loaded(self):
# Use paging when the total size, number of rows or number of
# columns is too large
size = self.total_rows * self.total_cols
if size > LARGE_SIZE:
self.rows_loaded = min(self.ROWS_TO_LOAD, self.total_rows)
self.cols_loaded = min(self.COLS_TO_LOAD, self.total_cols)
else:
if self.total_rows > LARGE_NROWS:
self.rows_loaded = self.ROWS_TO_LOAD
else:
self.rows_loaded = self.total_rows
if self.total_cols > LARGE_COLS:
self.cols_loaded = self.COLS_TO_LOAD
else:
self.cols_loaded = self.total_cols
def flags(self, index):
raise NotImplementedError()
def headerData(self, section, orientation, role=Qt.DisplayRole):
return None
def data(self, index, role=Qt.DisplayRole):
raise NotImplementedError()
def reset(self):
self.beginResetModel()
self.endResetModel()
if logger.isEnabledFor(logging.DEBUG):
caller = stack()[1]
logger.debug(f"model {self.__class__} has been reset after call of {caller.function} from module "
f"{basename(caller.filename)} at line {caller.lineno}")
class AxesArrayModel(AbstractArrayModel):
"""Axes Table Model.
Parameters
----------
parent : QWidget, optional
Parent Widget.
readonly : bool, optional
If True, data cannot be changed. False by default.
font : QFont, optional
Font. Default is `Calibri` with size 11.
"""
def __init__(self, parent=None, readonly=False, font=None):
AbstractArrayModel.__init__(self, parent, readonly, font)
self.font.setBold(True)
def _set_data(self, data):
# TODO: use sequence instead
if not isinstance(data, (list, tuple)):
QMessageBox.critical(self.dialog, "Error", "Expected list or tuple")
data = []
self._data = data
self.total_rows = 1
self.total_cols = len(data)
self._compute_rows_cols_loaded()
def flags(self, index):
"""Set editable flag"""
return Qt.ItemIsEnabled
def get_value(self, index):
i = index.column()
return str(self._data[i])
def get_values(self, left=0, right=None):
if right is None:
right = self.total_cols
values = self._data[left:right]
return values
def data(self, index, role=Qt.DisplayRole):
if not index.isValid():
return None
if role == Qt.TextAlignmentRole:
return int(Qt.AlignCenter | Qt.AlignVCenter)
elif role == Qt.FontRole:
return self.font
elif role == Qt.BackgroundColorRole:
color = QColor(Qt.lightGray)
color.setAlphaF(.4)
return color
elif role == Qt.DisplayRole:
return self.get_value(index)
# elif role == Qt.ToolTipRole:
# return None
else:
return None
class LabelsArrayModel(AbstractArrayModel):
"""Labels Table Model.
Parameters
----------
parent : QWidget, optional
Parent Widget.
readonly : bool, optional
If True, data cannot be changed. False by default.
font : QFont, optional
Font. Default is `Calibri` with size 11.
"""
def __init__(self, parent=None, readonly=False, font=None):
AbstractArrayModel.__init__(self, parent, readonly, font)
self.font.setBold(True)
def _set_data(self, data):
# TODO: use sequence instead
if not isinstance(data, (list, tuple, Product)):
QMessageBox.critical(self.dialog, "Error", "Expected list, tuple or Product")
data = [[]]
self._data = data
self.total_rows = len(data[0])
self.total_cols = len(data) if self.total_rows > 0 else 0
self._compute_rows_cols_loaded()
def flags(self, index):
"""Set editable flag"""
return Qt.ItemIsEnabled
def get_value(self, index):
i = index.row()
j = index.column()
# we need to inverse column and row because of the way vlabels are generated
return str(self._data[j][i])
# XXX: I wonder if we shouldn't return a 2D Numpy array of strings?
def get_values(self, left=0, top=0, right=None, bottom=None):
if right is None:
right = self.total_rows
if bottom is None:
bottom = self.total_cols
values = [list(line[left:right]) for line in self._data[top:bottom]]
return values
def data(self, index, role=Qt.DisplayRole):
if not index.isValid():
return None
if role == Qt.TextAlignmentRole:
return int(Qt.AlignCenter | Qt.AlignVCenter)
elif role == Qt.FontRole:
return self.font
elif role == Qt.BackgroundColorRole:
color = QColor(Qt.lightGray)
color.setAlphaF(.4)
return color
elif role == Qt.DisplayRole:
return self.get_value(index)
# elif role == Qt.ToolTipRole:
# return None
else:
return None
class DataArrayModel(AbstractArrayModel):
"""Data Table Model.
Parameters
----------
parent : QWidget, optional
Parent Widget.
readonly : bool, optional
If True, data cannot be changed. False by default.
format : str, optional
Indicates how data is represented in cells.
By default, they are represented as floats with 3 decimal points.
font : QFont, optional
Font. Default is `Calibri` with size 11.
bg_gradient : LinearGradient, optional
Background color gradient
bg_value : Numpy ndarray, optional
Background color value. Must have the shape as data
minvalue : scalar, optional
Minimum value allowed.
maxvalue : scalar, optional
Maximum value allowed.
"""
ROWS_TO_LOAD = 500
COLS_TO_LOAD = 40
newChanges = Signal(dict)
def __init__(self, parent=None, readonly=False, format="%.3f", font=None, minvalue=None, maxvalue=None):
AbstractArrayModel.__init__(self, parent, readonly, font)
self._format = format
self.minvalue = minvalue
self.maxvalue = maxvalue
self.color_func = None
self.vmin = None
self.vmax = None
self.bgcolor_possible = False
self.bg_value = None
self.bg_gradient = None
def get_format(self):
"""Return current format"""
# Avoid accessing the private attribute _format from outside
return self._format
def get_data(self):
"""Return data"""
return self._data
def _set_data(self, data):
# TODO: check that data respects minvalue/maxvalue
assert isinstance(data, np.ndarray) and data.ndim == 2
self._data = data
dtype = data.dtype
if dtype.names is None:
dtn = dtype.name
if dtn not in SUPPORTED_FORMATS and not dtn.startswith('str') \
and not dtn.startswith('unicode'):
QMessageBox.critical(self.dialog, "Error", f"{dtn} arrays are currently not supported")
return
# for complex numbers, shading will be based on absolute value
# but for all other types it will be the real part
# TODO: there are a lot more complex dtypes than this. Is there a way to get them all in one shot?
if dtype in (np.complex64, np.complex128):
self.color_func = np.abs
else:
self.color_func = None
# --------------------------------------
self.total_rows, self.total_cols = self._data.shape
self._compute_rows_cols_loaded()
def reset_minmax(self):
try:
data = self.get_values(sample=True)
color_value = self.color_func(data) if self.color_func is not None else data
if color_value.dtype.type == np.object_:
color_value = color_value[is_number_value(color_value)]
# this is probably broken if we have complex numbers stored as objects but I don't foresee
# this case happening anytime soon.
color_value = color_value.astype(float)
# ignore nan, -inf, inf (setting them to 0 or to very large numbers is not an option)
color_value = color_value[np.isfinite(color_value)]
if color_value.size:
self.vmin = float(np.min(color_value))
self.vmax = float(np.max(color_value))
else:
self.vmin = np.nan
self.vmax = np.nan
self.bgcolor_possible = True
# ValueError for empty arrays, TypeError for object/string arrays
except (TypeError, ValueError):
self.vmin = None
self.vmax = None
self.bgcolor_possible = False
def set_format(self, format, reset=True):
"""Change display format"""
self._format = format
if reset:
self.reset()
def set_bg_gradient(self, bg_gradient, reset=True):
if bg_gradient is not None and not isinstance(bg_gradient, LinearGradient):
raise ValueError("Expected None or LinearGradient instance for `bg_gradient` argument")
self.bg_gradient = bg_gradient
if reset:
self.reset()
def set_bg_value(self, bg_value, reset=True):
if bg_value is not None and not (isinstance(bg_value, np.ndarray) and bg_value.shape == self._data.shape):
raise ValueError(f"Expected None or 2D Numpy ndarray with shape {self._data.shape} for `bg_value` argument")
self.bg_value = bg_value
if reset:
self.reset()
def get_value(self, index):
i, j = index.row(), index.column()
return self._data[i, j]
def flags(self, index):
"""Set editable flag"""
if not index.isValid():
return Qt.ItemIsEnabled
flags = QAbstractTableModel.flags(self, index)
if not self.readonly:
flags |= Qt.ItemIsEditable
return flags
def data(self, index, role=Qt.DisplayRole):
"""Cell content"""
if not index.isValid():
return None
# if role == Qt.DecorationRole:
# return ima.icon('editcopy')
# if role == Qt.DisplayRole:
# return ""
if role == Qt.TextAlignmentRole:
return int(Qt.AlignRight | Qt.AlignVCenter)
elif role == Qt.FontRole:
return self.font
value = self.get_value(index)
if role == Qt.DisplayRole:
if value is np.ma.masked:
return ''
# for headers
elif isinstance(value, str) and not isinstance(value, np.str_):
return value
else:
return self._format % value
elif role == Qt.BackgroundColorRole:
if self.bgcolor_possible and self.bg_gradient is not None and value is not np.ma.masked:
if self.bg_value is None:
try:
v = self.color_func(value) if self.color_func is not None else value
if np.isnan(v):
v = np.nan
else:
do_reset = False
if np.isnan(self.vmin) or -np.inf < v < self.vmin:
# TODO: this is suboptimal, as it can reset many times (though in practice, it is
# usually ok). When we get buffering, we will need to compute vmin/vmax on the
# whole buffer at once, eliminating this problem (and we could even compute final
# colors directly all at once)
self.vmin = v
do_reset = True
if np.isnan(self.vmax) or self.vmax < v < np.inf:
self.vmax = v
do_reset = True
if do_reset:
self.reset()
v = scale_to_01range(v, self.vmin, self.vmax)
except TypeError:
v = np.nan
else:
i, j = index.row(), index.column()
v = self.bg_value[i, j]
return self.bg_gradient[v]
# elif role == Qt.ToolTipRole:
# return f"{repr(value)}\n{self.get_labels(index)}"
return None
def get_values(self, left=0, top=0, right=None, bottom=None, sample=False):
width, height = self.total_rows, self.total_cols
if right is None:
right = width
if bottom is None:
bottom = height
values = self._data[left:right, top:bottom]
if sample:
sample_indices = get_sample_indices(values, 500)
# we need to keep the dtype, otherwise numpy might convert mixed object arrays to strings
return np.array([values[i, j] for i, j in zip(*sample_indices)], dtype=values.dtype)
else:
return values
def convert_value(self, value):
"""
Parameters
----------
value : str
"""
dtype = self._data.dtype
if dtype.name == "bool":
try:
return bool(float(value))
except ValueError:
return value.lower() == "true"
elif dtype.name.startswith("string"):
return str(value)
elif dtype.name.startswith("unicode"):
return to_text_string(value)
elif is_float(dtype):
return float(value)
elif is_number(dtype):
return int(value)
else:
return complex(value)
def convert_values(self, values):
values = np.asarray(values)
res = np.empty_like(values, dtype=self._data.dtype)
try:
# TODO: use array/vectorized conversion functions (but watch out
# for bool)
# new_data = str_array.astype(data.dtype)
for i, v in enumerate(values.flat):
res.flat[i] = self.convert_value(v)
except ValueError as e:
QMessageBox.critical(self.dialog, "Error", f"Value error: {str(e)}")
return None
except OverflowError as e:
QMessageBox.critical(self.dialog, "Error", f"Overflow error: {e.message}")
return None
return res
# TODO: I wonder if set_values should not actually change the data. In that case, ArrayEdtiorWidget.paste
# and DataArrayModel.setData should call another method "queueValueChange" or something like that. In any case
# it must be absolutely clear from either the method name, an argument (eg. update_data=False) or from the
# class name that the data is not changed directly.
# I am also unsure how this all thing will interect with the big adapter/model refactor in the buffer branch.
def set_values(self, left, top, right, bottom, values):
"""
This does NOT actually change any data directly. It will emit a signal that the data was changed,
which is intercepted by the undo-redo system which creates a command to change the values, execute it and
call .reset() on this model, which fetches and displays the new data. It is apparently NOT possible to add a
QUndoCommand onto the QUndoStack without executing it.
To add to the strangeness, this method updates self.vmin and self.vmax immediately, which leads to very odd
results (the color is updated but not the value) if one forgets to connect the newChanges signal to the
undo-redo system.
Parameters
----------
left : int
top : int
right : int
exclusive
bottom : int
exclusive
values : ndarray
must not be of the correct type
Returns
-------
tuple of QModelIndex or None
actual bounds (end bound is inclusive) if update was successful,
None otherwise
"""
values = self.convert_values(values)
if values is None:
return
values = np.atleast_2d(values)
vshape = values.shape
vwidth, vheight = vshape
width, height = right - left, bottom - top
assert vwidth == 1 or vwidth == width
assert vheight == 1 or vheight == height
# Add change to self.changes
# requires numpy 1.10
changes = {}
newvalues = np.broadcast_to(values, (width, height))
oldvalues = np.empty_like(newvalues)
for i in range(width):
for j in range(height):
pos = left + i, top + j
old_value = self._data[pos]
oldvalues[i, j] = old_value
new_value = newvalues[i, j]
if new_value != old_value:
changes[pos] = (old_value, new_value)
# Update vmin/vmax if necessary
if self.vmin is not None and self.vmax is not None:
# FIXME: -inf/+inf and non-number values should be ignored here too
colorval = self.color_func(values) if self.color_func is not None else values
old_colorval = self.color_func(oldvalues) if self.color_func is not None else oldvalues
# we need to lower vmax or increase vmin
if np.any(((old_colorval == self.vmax) & (colorval < self.vmax)) |
((old_colorval == self.vmin) & (colorval > self.vmin))):
self.reset_minmax()
self.reset()
# this is faster, when the condition is False (which should be most of the cases) than computing
# subset_max and checking if subset_max > self.vmax
if np.any(colorval > self.vmax):
self.vmax = float(np.nanmax(colorval))
self.reset()
if np.any(colorval < self.vmin):
self.vmin = float(np.nanmin(colorval))
self.reset()
# DataArrayModel should have a reference to an adapter?
if len(changes) > 0:
self.newChanges.emit(changes)
# XXX: I wonder if emitting dataChanged makes any sense since data has not actually changed!
top_left = self.index(left, top)
# -1 because Qt index end bounds are inclusive
bottom_right = self.index(right - 1, bottom - 1)
self.dataChanged.emit(top_left, bottom_right)
return top_left, bottom_right
def setData(self, index, value, role=Qt.EditRole):
"""Cell content change"""
if not index.isValid() or self.readonly:
return False
i, j = index.row(), index.column()
result = self.set_values(i, j, i + 1, j + 1, value)
return result is not None