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
|
#
# This file is part of the PyMeasure package.
#
# Copyright (c) 2013-2024 PyMeasure Developers
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
import logging
from functools import partial
import numpy as np
import pyqtgraph as pg
import pandas as pd
from ..Qt import QtCore, QtWidgets, QtGui
from .tab_widget import TabWidget
from ...experiment import Procedure
SORT_ROLE = QtCore.Qt.ItemDataRole.UserRole + 1
SORTING_ENABLED = True # Allow to disable sorting, for debug purpose only
log = logging.getLogger(__name__)
log.addHandler(logging.NullHandler())
class ResultsTable(QtCore.QObject):
""" Class representing a panda dataframe """
data_changed = QtCore.Signal(int, int, int, int)
def __init__(self, results, color, column_index=None,
force_reload=False, wdg=None, **kwargs):
super().__init__()
self.results = results
self.color = color
self.force_reload = force_reload
self.last_row_count = 0
self.wdg = wdg
self.column_index = column_index
self.data = self.results.data
self._started = False
@property
def data(self):
return self._data
@data.setter
def data(self, value):
self._data = value
if self.column_index is not None:
self._data = self._data.set_index(self.column_index)
else:
self._data.reset_index()
@property
def rows(self):
return self._data.shape[0]
@property
def columns(self):
return self._data.shape[1]
def init(self):
self.last_row_count = 0
def start(self):
self._started = True
def stop(self):
self._started = False
def update_data(self):
if not self._started:
return
if self.force_reload:
self.results.reload()
self.data = self.results.data
current_row_count, columns = self._data.shape
if (self.last_row_count < current_row_count):
# Request cells content update
self.data_changed.emit(self.last_row_count, 0,
current_row_count - 1, columns - 1)
self.last_row_count = current_row_count
def set_color(self, color):
self.color = color
def set_index(self, index):
self.column_index = index
class PandasModelBase(QtCore.QAbstractTableModel):
""" This class provided a model to manage multiple panda dataframes and
display them as a single table.
The multiple pandas dataframes are provided as ResultTable class instances
and all of them share the same number of columns.
There are some assumptions:
- Series in the dataframe are identical, we call this number k
- Series length can be different, we call this number l(x), where x=1..n
The data can be presented as follow:
- By column: each series in a separate column, in this case table shape
will be: (k*n) x (max(l(x) x=1..n)
- By row: column fixed to the number of series, in this case table shape
will be: k x (sum of l(x) x=1..n)
"""
float_digits = 6
concat_axis = 0
def __init__(self, column_index=None, results_list=[], parent=None):
super().__init__(parent)
self.column_index = column_index
self._init_data(results_list)
def _init_data(self, results_list=None):
if results_list is None:
results_list = []
self.results_list = results_list
self.row_count = self.pandas_row_count()
self.column_count = self.pandas_column_count()
def clear(self):
self.beginResetModel()
for results in self.results_list:
results.stop()
self._init_data()
self.endResetModel()
def add_results(self, results):
if results not in self.results_list:
self.beginResetModel()
self.results_list.append(results)
results.data_changed.connect(partial(self._data_changed, results))
self.endResetModel()
results.init()
results.start()
results.update_data()
def remove_results(self, results):
self.beginResetModel()
if results in self.results_list:
self.results_list.remove(results)
self.row_count = self.pandas_row_count()
self.column_count = self.pandas_column_count()
results.stop()
self.endResetModel()
def rowCount(self, parent=None):
return self.row_count
def columnCount(self, parent=None):
return self.column_count
def data(self, index, role=QtCore.Qt.ItemDataRole.DisplayRole):
if index.isValid() and role in (QtCore.Qt.ItemDataRole.DisplayRole, SORT_ROLE):
try:
results, row, col = self.translate_to_local(index.row(), index.column())
value = results.data.iat[row, col]
column_type = results.data.dtypes.iat[col]
# Cast to column type
value_render = column_type.type(value)
except (IndexError, ValueError, TypeError):
value = np.nan
value_render = ""
if isinstance(value_render, np.float64):
# limit maximum number of decimal digits displayed
value_render = f"{value_render:.{self.float_digits:d}g}"
if role == QtCore.Qt.ItemDataRole.DisplayRole:
return str(value_render)
elif role == SORT_ROLE:
# For numerical sort
return float(value)
return None
def _get_new_rows_columns(self, results, r1, c1, r2, c2):
new_rows = self.pandas_row_count() - self.row_count
new_rows_start = self.row_count
new_columns = self.pandas_column_count() - self.column_count
new_columns_start = self.column_count
return new_rows, new_rows_start, new_columns, new_columns_start
def headerData(self, section, orientation, role):
""" Return header information
Override method from QAbstractTableModel
"""
if role == QtCore.Qt.ItemDataRole.DisplayRole:
if orientation == QtCore.Qt.Orientation.Horizontal:
return str(self.horizontal_header[section])
if orientation == QtCore.Qt.Orientation.Vertical:
return str(self.vertical_header[section])
elif role == QtCore.Qt.ItemDataRole.DecorationRole:
if orientation == QtCore.Qt.Orientation.Horizontal:
return self.horizontal_header_decoration(section)
if orientation == QtCore.Qt.Orientation.Vertical:
return self.vertical_header_decoration(section)
return None
def _data_changed(self, results, r1, c1, r2, c2):
""" Internal method to handle data changed signal """
rows, rows_start, columns, columns_start = \
self._get_new_rows_columns(results, r1, c1, r2, c2)
if rows or columns:
if rows > 0:
# New rows available
self.beginInsertRows(QtCore.QModelIndex(),
rows_start,
rows_start + rows - 1)
self.row_count += rows
self.endInsertRows()
if columns > 0:
# New columns available
self.beginInsertColumns(QtCore.QModelIndex(),
columns_start,
columns_start + columns - 1)
self.column_count += columns
self.endInsertColumns()
else:
top_bottom = self._get_row_column_set(results, r1, c1, r2, c2)
for r1, c1, r2, c2 in top_bottom:
self.dataChanged.emit(self.createIndex(r1, c1),
self.createIndex(r2, c2))
def pandas_row_count(self):
""" Return total row count of the panda dataframes
The value depends on the geometry selected to display dataframes
"""
raise Exception("Subclass should implement it")
def pandas_column_count(self):
""" Return total column count of the panda dataframes
The value depends on the geometry selected to display dataframes
"""
raise Exception("Subclass should implement it")
def _get_row_column_set(self, results, r1, c1, r2, c2):
""" Return set of top/bottom coordinates for data changed event.
Depending on the geometry of the table a single top/bottom could be
translated in multiple tops/bottoms
"""
raise Exception("Subclass should implement it")
def translate_to_local(self, row, col):
""" Translate from full table coordinate to single results coordinates """
raise Exception("Subclass should implement it")
def translate_to_global(self, results, row, col):
""" Translate from single results coordinates to full table coordinates """
raise Exception("Subclass should implement it")
@property
def horizontal_header(self):
raise Exception("Subclass should implement it")
@property
def vertical_header(self):
return range(self.row_count)
def horizontal_header_decoration(self, section):
return None
def vertical_header_decoration(self, section):
return None
def export_df(self):
df_list = [results.data for results in self.results_list]
if not df_list: # Empty list
df = None
else:
# Concatenate pandas data frames
df = pd.concat(df_list, axis=self.concat_axis).replace(to_replace=np.nan, value="")
return df
def set_index(self, index):
self.column_index = index
# Update results list
for r in self.results_list:
r.stop()
r.set_index(index)
self.beginResetModel()
for r in self.results_list:
r.start()
r.update_data()
self.row_count = self.pandas_row_count()
self.column_count = self.pandas_column_count()
self.endResetModel()
def copy_model(self, model_class):
model = model_class(self.column_index, self.results_list[:])
return model
class PandasModelByRow(PandasModelBase):
concat_axis = 0
def pandas_row_count(self):
rows = 0
for r in self.results_list:
rows += r.rows
return rows
def pandas_column_count(self):
cols = 0
if self.results_list:
cols = self.results_list[0].columns
return cols
def _get_row_column_set(self, results, r1, c1, r2, c2):
top = self.translate_to_global(results, r1, c1)
bottom = self.translate_to_global(results, r2, c2)
return (top + bottom),
def translate_to_local(self, row, col):
""" Translate from full table coordinate to single results coordinates """
for index, results in enumerate(self.results_list):
if row < results.rows:
break
row -= results.rows
return results, row, col
def translate_to_global(self, results, row, col):
""" Translate from single results coordinates to full table coordinates """
rows = 0
for res in self.results_list:
if res == results:
break
rows += results.rows
return rows + row, col
@property
def vertical_header(self):
if self.column_index is None:
header = range(self.row_count)
else:
header = []
for r in self.results_list:
header.extend(r.data.index)
return header
@property
def horizontal_header(self):
if self.results_list:
return self.results_list[0].data.columns
else:
return []
def vertical_header_decoration(self, section):
results, _, _ = self.translate_to_local(section, 0)
pixelmap = QtGui.QPixmap(6, 6)
pixelmap.fill(results.color)
return pixelmap
class PandasModelByColumn(PandasModelBase):
concat_axis = 1
def pandas_row_count(self):
if self.column_index is None:
return max([0] + [r.rows for r in self.results_list])
else:
return len(self.vertical_header)
def pandas_column_count(self):
cols = 0
size = len(self.results_list)
if size > 0:
cols = self.results_list[0].columns * size
return cols
def _get_row_column_set(self, results, r1, c1, r2, c2):
top_bottoms = []
for i in range(c1, c2 + 1):
top = self.translate_to_global(results, r1, i)
bottom = self.translate_to_global(results, r2, i)
top_bottoms.append(top + bottom)
return top_bottoms
def translate_to_local(self, row, col):
""" Translate from full table coordinate to single results coordinates """
columns = 0
for index, results in enumerate(self.results_list):
if col < (columns + results.columns):
break
columns += results.columns
if (self.column_index is not None):
# Remap row to matching index entry when indexing is used
try:
index = self.vertical_header[row]
row = list(results.data.index).index(index)
except ValueError:
row = None
return results, row, col - columns
def translate_to_global(self, results, row, col):
""" Translate from single results coordinates to full table coordinates """
columns = 0
for res in self.results_list:
if res == results:
break
columns += results.columns
return row, col + columns
@property
def horizontal_header(self):
size = len(self.results_list)
if size:
v = list(self.results_list[0].data.columns)
return v * size
else:
return []
def horizontal_header_decoration(self, section):
results, _, _ = self.translate_to_local(0, section)
pixelmap = QtGui.QPixmap(6, 6)
pixelmap.fill(results.color)
return pixelmap
@property
def vertical_header(self):
header = set([])
for r in self.results_list:
header = header.union(set(r.data.index))
header = sorted(list(header))
return header
class Table(QtWidgets.QTableView):
""" Table format view of :class:`Experiment<pymeasure.display.manager.Experiment>`
objects
"""
supported_formats = {
"CSV file (*.csv)": 'csv',
"Excel file (*.xlsx)": 'excel',
"HTML file (*.html *.htm)": 'html',
"JSON file (*.json)": 'json',
"LaTeX file (*.tex)": 'latex',
"Markdown file (*.md)": 'markdown',
"XML file (*.xml)": 'xml',
}
def __init__(self, refresh_time=0.2, check_status=True,
force_reload=False, layout_class=PandasModelByColumn,
column_index=None, float_digits=6, parent=None):
super().__init__(parent)
self.force_reload = force_reload
self.float_digits = float_digits
model = layout_class(column_index=column_index)
self.setModel(model)
self.horizontalHeader().setStyleSheet("font: bold;")
self.sortByColumn(-1, QtCore.Qt.SortOrder.AscendingOrder)
self.setSortingEnabled(True)
self.horizontalHeader().setSectionsMovable(True)
self.horizontalHeader().setSectionResizeMode(
QtWidgets.QHeaderView.ResizeMode.ResizeToContents
)
self.setup_context_menu()
self.refresh_time = refresh_time
self.check_status = check_status
if self.refresh_time is not None:
self.timer = QtCore.QTimer(self)
self.timer.timeout.connect(self.update_tables)
self.timer.start(int(self.refresh_time * 1e3))
def setModel(self, model):
model.float_digits = self.float_digits
if SORTING_ENABLED:
proxyModel = QtCore.QSortFilterProxyModel(self)
proxyModel.setSourceModel(model)
model = proxyModel
model.setSortRole(SORT_ROLE)
super().setModel(model)
def source_model(self):
model = self.model()
if SORTING_ENABLED:
model = model.sourceModel()
return model
def export_action(self):
df = self.source_model().export_df()
if df is not None:
formats = ";;".join(self.supported_formats.keys())
filename_and_ext = QtWidgets.QFileDialog.getSaveFileName(
self,
"Save File",
"",
formats,
)
filename = filename_and_ext[0]
ext = filename_and_ext[1]
if filename:
mode = self.supported_formats[ext]
prefix = df.style if mode == "latex" else df
getattr(prefix, 'to_' + mode)(filename)
def refresh_action(self):
self.update_tables()
def copy_action(self):
df = self.source_model().export_df()
if df is not None:
df.to_clipboard()
def setup_context_menu(self):
self.setContextMenuPolicy(QtCore.Qt.ContextMenuPolicy.CustomContextMenu)
self.customContextMenuRequested.connect(self.context_menu)
self.copy = QtGui.QAction("Copy table data", self)
self.copy.triggered.connect(self.copy_action)
self.refresh = QtGui.QAction("Refresh table data", self)
self.refresh.triggered.connect(self.refresh_action)
self.export = QtGui.QAction("Export table data", self)
self.export.triggered.connect(self.export_action)
def context_menu(self, point):
menu = QtWidgets.QMenu(self)
menu.addAction(self.copy)
menu.addAction(self.refresh)
menu.addAction(self.export)
menu.exec(self.mapToGlobal(point))
def update_tables(self, force=False):
model = self.source_model()
for item in model.results_list:
if not self.check_status or force:
item.update_data()
else:
if item.results.procedure.status == Procedure.RUNNING:
item.update_data()
def set_color(self, table, color):
table.set_color(color)
def add_table(self, table):
model = self.source_model()
model.add_results(table)
def remove_table(self, table):
model = self.source_model()
model.remove_results(table)
table.stop()
if model.rowCount() == 0:
# Empty table, reset sorting policy
self.setSortingEnabled(False)
self.sortByColumn(-1, QtCore.Qt.SortOrder.AscendingOrder)
self.setSortingEnabled(True)
def clear(self):
model = self.source_model()
model.clear()
self.setSortingEnabled(False)
self.sortByColumn(-1, QtCore.Qt.SortOrder.AscendingOrder)
self.setSortingEnabled(True)
def set_index(self, index):
model = self.source_model()
model.set_index(index)
def set_model(self, model_class):
""" Replace model with new instance of model_class """
model = self.source_model()
new_model = model.copy_model(model_class)
self.setModel(new_model)
class TableWidget(TabWidget, QtWidgets.QWidget):
""" Widget to display experiment data in a tabular format
"""
layout_class_map = {
'By Row': PandasModelByRow,
'By Column': PandasModelByColumn,
}
def __init__(self, name, columns, by_column=True,
column_index=None, refresh_time=0.2,
float_digits=6,
check_status=True, parent=None):
super().__init__(name, parent)
self.columns = columns
self.layout_names = list(self.layout_class_map.keys())
self.table_layout = self.layout_names[1] if by_column else self.layout_names[0]
self.column_index = column_index
self.refresh_time = refresh_time
self.check_status = check_status
self.float_digits = float_digits
self._setup_ui()
self._layout()
def _setup_ui(self):
self.column_index_label = QtWidgets.QLabel(self)
self.column_index_label.setMaximumSize(QtCore.QSize(45, 16777215))
self.column_index_label.setText('Index:')
self.layout_label = QtWidgets.QLabel(self)
self.layout_label.setMaximumSize(QtCore.QSize(45, 16777215))
self.layout_label.setText('Layout:')
self.column_index_combo = QtWidgets.QComboBox(self)
self.layout = QtWidgets.QComboBox(self)
self.column_index_combo.addItem('<None>')
for column in self.columns:
self.column_index_combo.addItem(column)
if self.column_index is not None:
self.column_index_combo.setCurrentText(self.column_index)
for key in self.layout_names:
self.layout.addItem(key)
self.layout.setCurrentText(self.table_layout)
self.column_index_combo.activated.connect(self.update_column_index)
self.layout.activated.connect(self.update_layout)
self.table = Table(refresh_time=self.refresh_time,
check_status=self.check_status,
force_reload=False,
layout_class=self.layout_class_map[self.table_layout],
column_index=self.column_index,
float_digits=self.float_digits,
parent=self,
)
def _layout(self):
vbox = QtWidgets.QVBoxLayout(self)
vbox.setSpacing(0)
hbox = QtWidgets.QHBoxLayout()
hbox.setSpacing(10)
hbox.setContentsMargins(-1, 6, -1, 6)
hbox.addWidget(self.column_index_label)
hbox.addWidget(self.column_index_combo)
hbox.addWidget(self.layout_label)
hbox.addWidget(self.layout)
vbox.addLayout(hbox)
vbox.addWidget(self.table)
self.setLayout(vbox)
def update_layout(self, entry):
model = self.layout.itemText(entry)
self.table_layout = entry
self.table.set_model(self.layout_class_map[model])
def update_column_index(self, entry):
index = self.column_index_combo.itemText(entry)
if index == '<None>':
index = None
self.column_index = index
self.table.set_index(index)
def new_curve(self, results, color=pg.intColor(0), **kwargs):
return ResultsTable(results, color, self.column_index, wdg=self, **kwargs)
def load(self, table):
self.table.add_table(table)
def remove(self, table):
self.table.remove_table(table)
def set_color(self, table, color):
""" Change the color of the pen of the curve """
self.table.set_color(table, color)
def preview_widget(self, parent=None):
""" Return a widget suitable for preview during loading """
by_column = False if self.table_layout == self.layout_names[0] else True
return TableWidget("Table preview",
columns=self.columns,
by_column=by_column,
refresh_time=None,
check_status=False,
float_digits=self.float_digits,
parent=None,
)
def clear_widget(self):
self.table.clear()
|