source: sasview/src/sas/qtgui/Utilities/GridPanel.py

ESS_GUI
Last change on this file was e03d56f, checked in by wojciech, 3 years ago

Fixing Batch Fitting help in simpler way

  • Property mode set to 100644
File size: 19.0 KB
Line 
1import os
2import sys
3import time
4import logging
5import webbrowser
6
7from PyQt5 import QtCore, QtWidgets, QtGui
8
9import sas.qtgui.Utilities.GuiUtils as GuiUtils
10from sas.qtgui.Plotting.PlotterData import Data1D
11from sas.qtgui.Utilities.UI.GridPanelUI import Ui_GridPanelUI
12
13
14class BatchOutputPanel(QtWidgets.QMainWindow, Ui_GridPanelUI):
15    """
16    Class for stateless grid-like printout of model parameters for mutiple models
17    """
18    ERROR_COLUMN_CAPTION = " (Err)"
19    IS_WIN = (sys.platform == 'win32')
20    windowClosedSignal = QtCore.pyqtSignal()
21    def __init__(self, parent = None, output_data=None):
22
23        super(BatchOutputPanel, self).__init__(parent._parent)
24        self.setupUi(self)
25
26        self.parent = parent
27        if hasattr(self.parent, "communicate"):
28            self.communicate = parent.communicate
29
30        self.addToolbarActions()
31
32        # file name for the dataset
33        self.grid_filename = ""
34
35        self.has_data = False if output_data is None else True
36        # Tab numbering
37        self.tab_number = 1
38
39        # save state
40        self.data_dict = {}
41
42        # System dependent menu items
43        if not self.IS_WIN:
44            self.actionOpen_with_Excel.setVisible(False)
45
46        # list of QTableWidgets, indexed by tab number
47        self.tables = []
48        self.tables.append(self.tblParams)
49
50        # context menu on the table
51        self.tblParams.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
52        self.tblParams.customContextMenuRequested.connect(self.showContextMenu)
53
54        # Command buttons
55        self.cmdHelp.clicked.connect(self.onHelp)
56        self.cmdPlot.clicked.connect(self.onPlot)
57
58        # Fill in the table from input data
59        self.setupTable(widget=self.tblParams, data=output_data)
60        if output_data is not None:
61            # Set a table tooltip describing the model
62            model_name = output_data[0][0].model.id
63            self.tabWidget.setTabToolTip(0, model_name)
64
65    def closeEvent(self, event):
66        """
67        Overwrite QDialog close method to allow for custom widget close
68        """
69        # notify the parent so it hides this window
70        self.windowClosedSignal.emit()
71        event.ignore()
72
73    def addToolbarActions(self):
74        """
75        Assing actions and callbacks to the File menu items
76        """
77        self.actionOpen.triggered.connect(self.actionLoadData)
78        self.actionOpen_with_Excel.triggered.connect(self.actionSendToExcel)
79        self.actionSave.triggered.connect(self.actionSaveFile)
80
81    def actionLoadData(self):
82        """
83        Open file load dialog and load a .csv file
84        """
85        datafile = QtWidgets.QFileDialog.getOpenFileName(
86            self, "Choose a file with results", "", "CSV files (*.csv)", None,
87            QtWidgets.QFileDialog.DontUseNativeDialog)[0]
88
89        if not datafile:
90            logging.info("No data file chosen.")
91            return
92
93        with open(datafile, 'r') as csv_file:
94            lines = csv_file.readlines()
95
96        self.setupTableFromCSV(lines)
97        self.has_data = True
98
99    def currentTable(self):
100        """
101        Returns the currently shown QTabWidget
102        """
103        return self.tables[self.tabWidget.currentIndex()]
104
105    def showContextMenu(self, position):
106        """
107        Show context specific menu in the tab table widget.
108        """
109        menu = QtWidgets.QMenu()
110        rows = [s.row() for s in self.currentTable().selectionModel().selectedRows()]
111        num_rows = len(rows)
112        if num_rows <= 0:
113            return
114        # Find out which items got selected and in which row
115        # Select for fitting
116
117        self.actionPlotResults = QtWidgets.QAction(self)
118        self.actionPlotResults.setObjectName("actionPlot")
119        self.actionPlotResults.setText(QtCore.QCoreApplication.translate("self", "Plot selected fits."))
120
121        menu.addAction(self.actionPlotResults)
122
123        # Define the callbacks
124        self.actionPlotResults.triggered.connect(self.onPlot)
125        try:
126            menu.exec_(self.currentTable().viewport().mapToGlobal(position))
127        except AttributeError as ex:
128            logging.error("Error generating context menu: %s" % ex)
129        return
130
131    def addTabPage(self, name=None):
132        """
133        Add new tab page with QTableWidget
134        """
135        layout = QtWidgets.QVBoxLayout()
136        tab_widget = QtWidgets.QTableWidget(parent=self)
137        # Same behaviour as the original tblParams
138        tab_widget.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
139        tab_widget.setAlternatingRowColors(True)
140        tab_widget.setSelectionBehavior(QtWidgets.QAbstractItemView.SelectRows)
141        tab_widget.setLayout(layout)
142        # Simple naming here.
143        # One would think naming the tab with current model name would be good.
144        # However, some models have LONG names, which doesn't look well on the tab bar.
145        self.tab_number += 1
146        if name is not None:
147            tab_name = name
148        else:
149            tab_name = "Tab " + str(self.tab_number)
150        # each table needs separate slots.
151        tab_widget.customContextMenuRequested.connect(self.showContextMenu)
152        self.tables.append(tab_widget)
153        self.tabWidget.addTab(tab_widget, tab_name)
154        # Make the new tab active
155        self.tabWidget.setCurrentIndex(self.tab_number-1)
156
157    def addFitResults(self, results):
158        """
159        Create a new tab with batch fitting results
160        """
161        # pull out page name from results
162        page_name = None
163        if len(results)>=2:
164            if isinstance(results[-1], str):
165                page_name = results[-1]
166                _ = results.pop(-1)
167
168        if self.has_data:
169            self.addTabPage(name=page_name)
170        else:
171            self.tabWidget.setTabText(0, page_name)
172        # Update the new widget
173        # Fill in the table from input data in the last/newest page
174        assert(self.tables)
175        self.setupTable(widget=self.tables[-1], data=results)
176        self.has_data = True
177
178        # Set a table tooltip describing the model
179        model_name = results[0][0].model.id
180        self.tabWidget.setTabToolTip(self.tabWidget.count()-1, model_name)
181        self.data_dict[page_name] = results
182
183    @classmethod
184    def onHelp(cls):
185        """
186        Open a local url in the default browser
187        """
188        url = "/user/qtgui/Perspectives/Fitting/fitting_help.html#batch-fit-mode"
189        GuiUtils.showHelp(url)
190
191
192    def onPlot(self):
193        """
194        Plot selected fits by sending signal to the parent
195        """
196        rows = [s.row() for s in self.currentTable().selectionModel().selectedRows()]
197        if not rows:
198            msg = "Nothing to plot!"
199            self.parent.communicate.statusBarUpdateSignal.emit(msg)
200            return
201        data = self.dataFromTable(self.currentTable())
202        # data['Data'] -> ['filename1', 'filename2', ...]
203        # look for the 'Data' column and extract the filename
204        for row in rows:
205            try:
206                filename = data['Data'][row]
207                # emit a signal so the plots are being shown
208                self.communicate.plotFromFilenameSignal.emit(filename)
209            except (IndexError, AttributeError):
210                # data messed up.
211                return
212
213    @classmethod
214    def dataFromTable(cls, table):
215        """
216        Creates a dictionary {<parameter>:[list of values]} from the parameter table
217        """
218        assert(isinstance(table, QtWidgets.QTableWidget))
219        params = {}
220        for column in range(table.columnCount()):
221            value = [table.item(row, column).data(0) for row in range(table.rowCount())]
222            key = table.horizontalHeaderItem(column).data(0)
223            params[key] = value
224        return params
225
226    def actionSendToExcel(self):
227        """
228        Generates a .csv file and opens the default CSV reader
229        """
230        if not self.grid_filename:
231            import tempfile
232            tmpfile = tempfile.NamedTemporaryFile(delete=False, mode="w+", suffix=".csv")
233            self.grid_filename = tmpfile.name
234            data = self.dataFromTable(self.currentTable())
235            t = time.localtime(time.time())
236            time_str = time.strftime("%b %d %H:%M of %Y", t)
237            details = "File Generated by SasView "
238            details += "on %s.\n" % time_str
239            self.writeBatchToFile(data=data, tmpfile=tmpfile, details=details)
240            tmpfile.close()
241
242        try:
243            from win32com.client import Dispatch
244            excel_app = Dispatch('Excel.Application')
245            excel_app.Workbooks.Open(self.grid_filename)
246            excel_app.Visible = 1
247        except Exception as ex:
248            msg = "Error occured when calling Excel.\n"
249            msg += ex
250            self.parent.communicate.statusBarUpdateSignal.emit(msg)
251
252    def actionSaveFile(self):
253        """
254        Generate a .csv file and dump it do disk
255        """
256        t = time.localtime(time.time())
257        time_str = time.strftime("%b %d %H %M of %Y", t)
258        default_name = "Batch_Fitting_"+time_str+".csv"
259
260        wildcard = "CSV files (*.csv);;"
261        kwargs = {
262            'caption'   : 'Save As',
263            'directory' : default_name,
264            'filter'    : wildcard,
265            'parent'    : None,
266        }
267        # Query user for filename.
268        filename_tuple = QtWidgets.QFileDialog.getSaveFileName(**kwargs)
269        filename = filename_tuple[0]
270
271        # User cancelled.
272        if not filename:
273            return
274        data = self.dataFromTable(self.currentTable())
275        details = "File generated by SasView\n"
276        with open(filename, 'w') as csv_file:
277            self.writeBatchToFile(data=data, tmpfile=csv_file, details=details)
278
279    def setupTableFromCSV(self, csv_data):
280        """
281        Create tablewidget items and show them, based on params
282        """
283        # Is this an empty grid?
284        if self.has_data:
285            # Add a new page
286            self.addTabPage()
287            # Access the newly created QTableWidget
288            current_page = self.tables[-1]
289        else:
290            current_page = self.tblParams
291        # headers
292        param_list = csv_data[1].rstrip().split(',')
293        # need to remove the 2 header rows to get the total data row number
294        rows = len(csv_data) -2
295        assert(rows > -1)
296        columns = len(param_list)
297        current_page.setColumnCount(columns)
298        current_page.setRowCount(rows)
299
300        for i, param in enumerate(param_list):
301            current_page.setHorizontalHeaderItem(i, QtWidgets.QTableWidgetItem(param))
302
303        # first - Chi2 and data filename
304        for i_row, row in enumerate(csv_data[2:]):
305            for i_col, col in enumerate(row.rstrip().split(',')):
306                current_page.setItem(i_row, i_col, QtWidgets.QTableWidgetItem(col))
307
308        current_page.resizeColumnsToContents()
309
310    def setupTable(self, widget=None, data=None):
311        """
312        Create tablewidget items and show them, based on params
313        """
314        # quietly leave is nothing to show
315        if data is None or widget is None:
316            return
317
318        # Figure out the headers
319        model = data[0][0]
320
321        disperse_params = list(model.model.dispersion.keys())
322        magnetic_params = model.model.magnetic_params
323        optimized_params = model.param_list
324        # Create the main parameter list
325        param_list = [m for m in model.model.params.keys() if (m not in model.model.magnetic_params and ".width" not in m)]
326
327        # add fitted polydisp parameters
328        param_list += [m+".width" for m in disperse_params if m+".width" in optimized_params]
329
330        # add fitted magnetic params
331        param_list += [m for m in magnetic_params if m in optimized_params]
332
333        # Check if 2D model. If not, remove theta/phi
334        if isinstance(model.data.sas_data, Data1D):
335            if 'theta' in param_list:
336                param_list.remove('theta')
337            if 'phi' in param_list:
338                param_list.remove('phi')
339
340        rows = len(data)
341        columns = len(param_list)
342
343        widget.setColumnCount(columns+2) # add 2 initial columns defined below
344        widget.setRowCount(rows)
345
346        # Insert two additional columns
347        param_list.insert(0, "Data")
348        param_list.insert(0, "Chi2")
349        for i, param in enumerate(param_list):
350            widget.setHorizontalHeaderItem(i, QtWidgets.QTableWidgetItem(param))
351
352        # dictionary of parameter errors for post-processing
353        # [param_name] = [param_column_nr, error_for_row_1, error_for_row_2,...]
354        error_columns = {}
355        # first - Chi2 and data filename
356        for i_row, row in enumerate(data):
357            # each row corresponds to a single fit
358            chi2 = row[0].fitness
359            filename = ""
360            if hasattr(row[0].data, "sas_data"):
361                filename = row[0].data.sas_data.filename
362            widget.setItem(i_row, 0, QtWidgets.QTableWidgetItem(GuiUtils.formatNumber(chi2, high=True)))
363            widget.setItem(i_row, 1, QtWidgets.QTableWidgetItem(str(filename)))
364            # Now, all the parameters
365            for i_col, param in enumerate(param_list[2:]):
366                if param in row[0].param_list:
367                    # parameter is on the to-optimize list - get the optimized value
368                    par_value = row[0].pvec[row[0].param_list.index(param)]
369                    # parse out errors and store them for later use
370                    err_value = row[0].stderr[row[0].param_list.index(param)]
371                    if param in error_columns:
372                        error_columns[param].append(err_value)
373                    else:
374                        error_columns[param] = [i_col, err_value]
375                else:
376                    # parameter was not varied
377                    par_value = row[0].model.params[param]
378
379                widget.setItem(i_row, i_col+2, QtWidgets.QTableWidgetItem(
380                    GuiUtils.formatNumber(par_value, high=True)))
381
382        # Add errors
383        error_list = list(error_columns.keys())
384        for error_param in error_list[::-1]: # must be reverse to keep column indices
385            # the offset for the err column: +2 from the first two extra columns, +1 to append this column
386            error_column = error_columns[error_param][0]+3
387            error_values = error_columns[error_param][1:]
388            widget.insertColumn(error_column)
389
390            column_name = error_param + self.ERROR_COLUMN_CAPTION
391            widget.setHorizontalHeaderItem(error_column, QtWidgets.QTableWidgetItem(column_name))
392
393            for i_row, error in enumerate(error_values):
394                item = QtWidgets.QTableWidgetItem(GuiUtils.formatNumber(error, high=True))
395                # Fancy, italic font for errors
396                font = QtGui.QFont()
397                font.setItalic(True)
398                item.setFont(font)
399                widget.setItem(i_row, error_column, item)
400
401        # resize content
402        widget.resizeColumnsToContents()
403
404    @classmethod
405    def writeBatchToFile(cls, data, tmpfile, details=""):
406        """
407        Helper to write result from batch into cvs file
408        """
409        name = tmpfile.name
410        if data is None or name is None or name.strip() == "":
411            return
412        _, ext = os.path.splitext(name)
413        separator = "\t"
414        if ext.lower() == ".csv":
415            separator = ","
416        tmpfile.write(details)
417        for col_name in data.keys():
418            tmpfile.write(col_name)
419            tmpfile.write(separator)
420        tmpfile.write('\n')
421        max_list = [len(value) for value in data.values()]
422        if len(max_list) == 0:
423            return
424        max_index = max(max_list)
425        index = 0
426        while index < max_index:
427            for value_list in data.values():
428                if index < len(value_list):
429                    tmpfile.write(str(value_list[index]))
430                    tmpfile.write(separator)
431                else:
432                    tmpfile.write('')
433                    tmpfile.write(separator)
434            tmpfile.write('\n')
435            index += 1
436
437
438class BatchInversionOutputPanel(BatchOutputPanel):
439    """
440        Class for stateless grid-like printout of P(r) parameters for any number
441        of data sets
442    """
443    def __init__(self, parent = None, output_data=None):
444
445        super(BatchInversionOutputPanel, self).__init__(parent._parent, output_data)
446        _translate = QtCore.QCoreApplication.translate
447        self.setWindowTitle(_translate("GridPanelUI", "Batch P(r) Results"))
448
449    def setupTable(self, widget=None,  data=None):
450        """
451        Create tablewidget items and show them, based on params
452        """
453        # headers
454        param_list = ['Filename', 'Rg [Å]', 'Chi^2/dof', 'I(Q=0)', 'Oscillations',
455                      'Background [Å^-1]', 'P+ Fraction', 'P+1-theta Fraction',
456                      'Calc. Time [sec]']
457
458        if data is None:
459            return
460        keys = data.keys()
461        rows = len(keys)
462        columns = len(param_list)
463        self.tblParams.setColumnCount(columns)
464        self.tblParams.setRowCount(rows)
465
466        for i, param in enumerate(param_list):
467            self.tblParams.setHorizontalHeaderItem(i, QtWidgets.QTableWidgetItem(param))
468
469        # first - Chi2 and data filename
470        for i_row, (filename, pr) in enumerate(data.items()):
471            out = pr.out
472            cov = pr.cov
473            if out is None:
474                logging.warning("P(r) for {} did not converge.".format(filename))
475                continue
476            self.tblParams.setItem(i_row, 0, QtWidgets.QTableWidgetItem(
477                "{}".format(filename)))
478            self.tblParams.setItem(i_row, 1, QtWidgets.QTableWidgetItem(
479                "{:.3g}".format(pr.rg(out))))
480            self.tblParams.setItem(i_row, 2, QtWidgets.QTableWidgetItem(
481                "{:.3g}".format(pr.chi2[0])))
482            self.tblParams.setItem(i_row, 3, QtWidgets.QTableWidgetItem(
483                "{:.3g}".format(pr.iq0(out))))
484            self.tblParams.setItem(i_row, 4, QtWidgets.QTableWidgetItem(
485                "{:.3g}".format(pr.oscillations(out))))
486            self.tblParams.setItem(i_row, 5, QtWidgets.QTableWidgetItem(
487                "{:.3g}".format(pr.background)))
488            self.tblParams.setItem(i_row, 6, QtWidgets.QTableWidgetItem(
489                "{:.3g}".format(pr.get_positive(out))))
490            self.tblParams.setItem(i_row, 7, QtWidgets.QTableWidgetItem(
491                "{:.3g}".format(pr.get_pos_err(out, cov))))
492            self.tblParams.setItem(i_row, 8, QtWidgets.QTableWidgetItem(
493                "{:.2g}".format(pr.elapsed)))
494
495        self.tblParams.resizeColumnsToContents()
496
497    @classmethod
498    def onHelp(cls):
499        """
500        Open a local url in the default browser
501        """
502        location = GuiUtils.HELP_DIRECTORY_LOCATION
503        url = "/user/qtgui/Perspectives/Fitting/fitting_help.html#batch-fit-mode"
504        try:
505            webbrowser.open('file://' + os.path.realpath(location + url))
506        except webbrowser.Error as ex:
507            logging.warning("Cannot display help. %s" % ex)
508
509    def closeEvent(self, event):
510        """Tell the parent window the window closed"""
511        self.parent.batchResultsWindow = None
512        event.accept()
Note: See TracBrowser for help on using the repository browser.