# # This file is part of the PyMeasure package. # # Copyright (c) 2013-2021 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 import os import subprocess, platform import pyqtgraph as pg from .browser import BrowserItem from .curves import ResultsCurve from .manager import Manager, Experiment, ImageExperiment, ImageManager from .Qt import QtCore, QtWidgets from .widgets import ( PlotWidget, BrowserWidget, InputsWidget, LogWidget, ResultsDialog, SequencerWidget, ImageWidget, DirectoryLineEdit, ) from ..experiment.results import Results log = logging.getLogger(__name__) log.addHandler(logging.NullHandler()) class PlotterWindow(QtWidgets.QMainWindow): """ A window for plotting experiment results. Should not be instantiated directly, but only via the :class:`~pymeasure.display.plotter.Plotter` class. .. seealso:: Tutorial :ref:`tutorial-plotterwindow` A tutorial and example code for using the Plotter and PlotterWindow. .. attribute plot:: The `pyqtgraph.PlotItem`_ object for this window. Can be accessed to further customise the plot view programmatically, e.g., display log-log or semi-log axes by default, change axis range, etc. .. pyqtgraph.PlotItem: http://www.pyqtgraph.org/documentation/graphicsItems/plotitem.html """ def __init__(self, plotter, refresh_time=0.1, parent=None): super().__init__(parent) self.plotter = plotter self.refresh_time = refresh_time columns = plotter.results.procedure.DATA_COLUMNS self.setWindowTitle('Results Plotter') self.main = QtWidgets.QWidget(self) vbox = QtWidgets.QVBoxLayout(self.main) vbox.setSpacing(0) hbox = QtWidgets.QHBoxLayout() hbox.setSpacing(6) hbox.setContentsMargins(-1, 6, -1, -1) file_label = QtWidgets.QLabel(self.main) file_label.setText('Data Filename:') self.file = QtWidgets.QLineEdit(self.main) self.file.setText(plotter.results.data_filename) hbox.addWidget(file_label) hbox.addWidget(self.file) vbox.addLayout(hbox) self.plot_widget = PlotWidget(columns, refresh_time=self.refresh_time, check_status=False) self.plot = self.plot_widget.plot vbox.addWidget(self.plot_widget) self.main.setLayout(vbox) self.setCentralWidget(self.main) self.main.show() self.resize(800, 600) self.curve = ResultsCurve(plotter.results, columns[0], columns[1], pen=pg.mkPen(color=pg.intColor(0), width=2), antialias=False) self.plot.addItem(self.curve) self.plot_widget.updated.connect(self.check_stop) def quit(self, evt=None): log.info("Quitting the Plotter") self.close() self.plotter.stop() def check_stop(self): """ Checks if the Plotter should stop and exits the Qt main loop if so """ if self.plotter.should_stop(): QtCore.QCoreApplication.instance().quit() class ManagedWindow(QtWidgets.QMainWindow): """ Abstract base class. The ManagedWindow provides an interface for inputting experiment parameters, running several experiments (:class:`~pymeasure.experiment.procedure.Procedure`), plotting result curves, and listing the experiments conducted during a session. The ManagedWindow uses a Manager to control Workers in a Queue, and provides a simple interface. The :meth:`~.queue` method must be overridden by the child class. .. seealso:: Tutorial :ref:`tutorial-managedwindow` A tutorial and example on the basic configuration and usage of ManagedWindow. .. attribute:: plot The `pyqtgraph.PlotItem`_ object for this window. Can be accessed to further customise the plot view programmatically, e.g., display log-log or semi-log axes by default, change axis range, etc. .. _pyqtgraph.PlotItem: http://www.pyqtgraph.org/documentation/graphicsItems/plotitem.html """ def __init__(self, procedure_class, inputs=(), displays=(), x_axis=None, y_axis=None, log_channel='', log_level=logging.INFO, parent=None, sequencer=False, sequencer_inputs=None, sequence_file=None, inputs_in_scrollarea=False, directory_input=False): super().__init__(parent) app = QtCore.QCoreApplication.instance() app.aboutToQuit.connect(self.quit) self.procedure_class = procedure_class self.inputs = inputs self.displays = displays self.use_sequencer = sequencer self.sequencer_inputs = sequencer_inputs self.sequence_file = sequence_file self.inputs_in_scrollarea = inputs_in_scrollarea self.directory_input = directory_input self.log = logging.getLogger(log_channel) self.log_level = log_level log.setLevel(log_level) self.log.setLevel(log_level) self.x_axis, self.y_axis = x_axis, y_axis self._setup_ui() self._layout() self.setup_plot(self.plot) def _setup_ui(self): self.log_widget = LogWidget() self.log.addHandler(self.log_widget.handler) # needs to be in Qt context? log.info("ManagedWindow connected to logging") if self.directory_input: self.directory_label = QtWidgets.QLabel(self) self.directory_label.setText('Directory') self.directory_line = DirectoryLineEdit(parent=self) self.queue_button = QtWidgets.QPushButton('Queue', self) self.queue_button.clicked.connect(self.queue) self.abort_button = QtWidgets.QPushButton('Abort', self) self.abort_button.setEnabled(False) self.abort_button.clicked.connect(self.abort) self.plot_widget = PlotWidget(self.procedure_class.DATA_COLUMNS, self.x_axis, self.y_axis) self.plot = self.plot_widget.plot self.browser_widget = BrowserWidget( self.procedure_class, self.displays, [self.x_axis, self.y_axis], parent=self ) self.browser_widget.show_button.clicked.connect(self.show_experiments) self.browser_widget.hide_button.clicked.connect(self.hide_experiments) self.browser_widget.clear_button.clicked.connect(self.clear_experiments) self.browser_widget.open_button.clicked.connect(self.open_experiment) self.browser = self.browser_widget.browser self.browser.setContextMenuPolicy(QtCore.Qt.CustomContextMenu) self.browser.customContextMenuRequested.connect(self.browser_item_menu) self.browser.itemChanged.connect(self.browser_item_changed) self.inputs = InputsWidget( self.procedure_class, self.inputs, parent=self ) self.manager = Manager(self.plot, self.browser, log_level=self.log_level, parent=self) self.manager.abort_returned.connect(self.abort_returned) self.manager.queued.connect(self.queued) self.manager.running.connect(self.running) self.manager.finished.connect(self.finished) self.manager.log.connect(self.log.handle) if self.use_sequencer: self.sequencer = SequencerWidget( self.sequencer_inputs, self.sequence_file, parent=self ) def _layout(self): self.main = QtWidgets.QWidget(self) inputs_dock = QtWidgets.QWidget(self) inputs_vbox = QtWidgets.QVBoxLayout(self.main) hbox = QtWidgets.QHBoxLayout() hbox.setSpacing(10) hbox.setContentsMargins(-1, 6, -1, 6) hbox.addWidget(self.queue_button) hbox.addWidget(self.abort_button) hbox.addStretch() if self.directory_input: vbox = QtWidgets.QVBoxLayout() vbox.addWidget(self.directory_label) vbox.addWidget(self.directory_line) vbox.addLayout(hbox) if self.inputs_in_scrollarea: inputs_scroll = QtWidgets.QScrollArea() inputs_scroll.setWidgetResizable(True) inputs_scroll.setFrameStyle(QtWidgets.QScrollArea.NoFrame) self.inputs.setSizePolicy(1, 0) inputs_scroll.setWidget(self.inputs) inputs_vbox.addWidget(inputs_scroll, 1) else: inputs_vbox.addWidget(self.inputs) if self.directory_input: inputs_vbox.addLayout(vbox) else: inputs_vbox.addLayout(hbox) inputs_vbox.addStretch(0) inputs_dock.setLayout(inputs_vbox) dock = QtWidgets.QDockWidget('Input Parameters') dock.setWidget(inputs_dock) dock.setFeatures(QtWidgets.QDockWidget.NoDockWidgetFeatures) self.addDockWidget(QtCore.Qt.LeftDockWidgetArea, dock) if self.use_sequencer: sequencer_dock = QtWidgets.QDockWidget('Sequencer') sequencer_dock.setWidget(self.sequencer) sequencer_dock.setFeatures(QtWidgets.QDockWidget.NoDockWidgetFeatures) self.addDockWidget(QtCore.Qt.LeftDockWidgetArea, sequencer_dock) tabs = QtWidgets.QTabWidget(self.main) tabs.addTab(self.plot_widget, "Results Graph") tabs.addTab(self.log_widget, "Experiment Log") splitter = QtWidgets.QSplitter(QtCore.Qt.Vertical) splitter.addWidget(tabs) splitter.addWidget(self.browser_widget) self.plot_widget.setMinimumSize(100, 200) vbox = QtWidgets.QVBoxLayout(self.main) vbox.setSpacing(0) vbox.addWidget(splitter) self.main.setLayout(vbox) self.setCentralWidget(self.main) self.main.show() self.resize(1000, 800) def quit(self, evt=None): if self.manager.is_running(): self.abort() self.close() def browser_item_changed(self, item, column): if column == 0: state = item.checkState(0) experiment = self.manager.experiments.with_browser_item(item) if state == 0: self.plot.removeItem(experiment.curve) else: experiment.curve.x = self.plot_widget.plot_frame.x_axis experiment.curve.y = self.plot_widget.plot_frame.y_axis experiment.curve.update() self.plot.addItem(experiment.curve) def browser_item_menu(self, position): item = self.browser.itemAt(position) if item is not None: experiment = self.manager.experiments.with_browser_item(item) menu = QtWidgets.QMenu(self) # Open action_open = QtWidgets.QAction(menu) action_open.setText("Open Data Externally") action_open.triggered.connect( lambda: self.open_file_externally(experiment.results.data_filename)) menu.addAction(action_open) # Change Color action_change_color = QtWidgets.QAction(menu) action_change_color.setText("Change Color") action_change_color.triggered.connect( lambda: self.change_color(experiment)) menu.addAction(action_change_color) # Remove action_remove = QtWidgets.QAction(menu) action_remove.setText("Remove Graph") if self.manager.is_running(): if self.manager.running_experiment() == experiment: # Experiment running action_remove.setEnabled(False) action_remove.triggered.connect(lambda: self.remove_experiment(experiment)) menu.addAction(action_remove) # Use parameters action_use = QtWidgets.QAction(menu) action_use.setText("Use These Parameters") action_use.triggered.connect( lambda: self.set_parameters(experiment.procedure.parameter_objects())) menu.addAction(action_use) menu.exec_(self.browser.viewport().mapToGlobal(position)) def remove_experiment(self, experiment): reply = QtWidgets.QMessageBox.question(self, 'Remove Graph', "Are you sure you want to remove the graph?", QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.No, QtWidgets.QMessageBox.No) if reply == QtWidgets.QMessageBox.Yes: self.manager.remove(experiment) def show_experiments(self): root = self.browser.invisibleRootItem() for i in range(root.childCount()): item = root.child(i) item.setCheckState(0, QtCore.Qt.Checked) def hide_experiments(self): root = self.browser.invisibleRootItem() for i in range(root.childCount()): item = root.child(i) item.setCheckState(0, QtCore.Qt.Unchecked) def clear_experiments(self): self.manager.clear() def open_experiment(self): dialog = ResultsDialog(self.procedure_class.DATA_COLUMNS, self.x_axis, self.y_axis) if dialog.exec_(): filenames = dialog.selectedFiles() for filename in map(str, filenames): if filename in self.manager.experiments: QtWidgets.QMessageBox.warning(self, "Load Error", "The file %s cannot be opened twice." % os.path.basename( filename)) elif filename == '': return else: results = Results.load(filename) experiment = self.new_experiment(results) experiment.curve.update() experiment.browser_item.progressbar.setValue(100.) self.manager.load(experiment) log.info('Opened data file %s' % filename) def change_color(self, experiment): color = QtWidgets.QColorDialog.getColor( initial=experiment.curve.opts['pen'].color(), parent=self) if color.isValid(): pixelmap = QtWidgets.QPixmap(24, 24) pixelmap.fill(color) experiment.browser_item.setIcon(0, QtWidgets.QIcon(pixelmap)) experiment.curve.setPen(pg.mkPen(color=color, width=2)) def open_file_externally(self, filename): """ Method to open the datafile using an external editor or viewer. Uses the default application to open a datafile of this filetype, but can be overridden by the child class in order to open the file in another application of choice. """ system = platform.system() if (system == 'Windows'): # The empty argument after the start is needed to be able to cope correctly with filenames with spaces proc = subprocess.Popen(['start', '', filename], shell=True) elif (system == 'Linux'): proc = subprocess.Popen(['xdg-open', filename]) elif (system == 'Darwin'): proc = subprocess.Popen(['open', filename]) else: raise Exception("{cls} method open_file_externally does not support {system} OS".format(cls=type(self).__name__,system=system)) def make_procedure(self): if not isinstance(self.inputs, InputsWidget): raise Exception("ManagedWindow can not make a Procedure" " without a InputsWidget type") return self.inputs.get_procedure() def new_curve(self, results, color=None, **kwargs): if color is None: color = pg.intColor(self.browser.topLevelItemCount() % 8) return self.plot_widget.new_curve(results, color=color, **kwargs) def new_experiment(self, results, curve=None): if curve is None: curve = self.new_curve(results) browser_item = BrowserItem(results, curve) return Experiment(results, curve, browser_item) def set_parameters(self, parameters): """ This method should be overwritten by the child class. The parameters argument is a dictionary of Parameter objects. The Parameters should overwrite the GUI values so that a user can click "Queue" to capture the same parameters. """ if not isinstance(self.inputs, InputsWidget): raise Exception("ManagedWindow can not set parameters" " without a InputsWidget") self.inputs.set_parameters(parameters) def queue(self): """ Abstract method, which must be overridden by the child class. Implementations must call ``self.manager.queue(experiment)`` and pass an ``experiment`` (:class:`~pymeasure.experiment.experiment.Experiment`) object which contains the :class:`~pymeasure.experiment.results.Results` and :class:`~pymeasure.experiment.procedure.Procedure` to be run. For example: .. code-block:: python def queue(self): filename = unique_filename('results', prefix="data") # from pymeasure.experiment procedure = self.make_procedure() # Procedure class was passed at construction results = Results(procedure, filename) experiment = self.new_experiment(results) self.manager.queue(experiment) """ raise NotImplementedError( "Abstract method ManagedWindow.queue not implemented") def setup_plot(self, plot): """ This method does nothing by default, but can be overridden by the child class in order to set up custom options for the plot This method is called during the constructor, after all other set up has been completed, and is provided as a convenience method to parallel Plotter. :param plot: This window's PlotItem instance. .. _PlotItem: http://www.pyqtgraph.org/documentation/graphicsItems/plotitem.html """ pass def abort(self): self.abort_button.setEnabled(False) self.abort_button.setText("Resume") self.abort_button.clicked.disconnect() self.abort_button.clicked.connect(self.resume) try: self.manager.abort() except: log.error('Failed to abort experiment', exc_info=True) self.abort_button.setText("Abort") self.abort_button.clicked.disconnect() self.abort_button.clicked.connect(self.abort) def resume(self): self.abort_button.setText("Abort") self.abort_button.clicked.disconnect() self.abort_button.clicked.connect(self.abort) if self.manager.experiments.has_next(): self.manager.resume() else: self.abort_button.setEnabled(False) def queued(self, experiment): self.abort_button.setEnabled(True) self.browser_widget.show_button.setEnabled(True) self.browser_widget.hide_button.setEnabled(True) self.browser_widget.clear_button.setEnabled(True) def running(self, experiment): self.browser_widget.clear_button.setEnabled(False) def abort_returned(self, experiment): if self.manager.experiments.has_next(): self.abort_button.setText("Resume") self.abort_button.setEnabled(True) else: self.browser_widget.clear_button.setEnabled(True) def finished(self, experiment): if not self.manager.experiments.has_next(): self.abort_button.setEnabled(False) self.browser_widget.clear_button.setEnabled(True) @property def directory(self): if not self.directory_input: raise ValueError("No directory input in the ManagedWindow") return self.directory_line.text() # TODO: Inheret from ManagedWindow to share code and features class ManagedImageWindow(QtWidgets.QMainWindow): """ Abstract base class. The MangedImageWindow provides an interface for inputting experiment parameters, running several experiments (:class:`~pymeasure.experiment.procedure.Procedure`), plotting result curves, and listing the experiments conducted during a session. The MangedImageWindow uses a Manager to control Workers in a Queue, and provides a simple interface. The :meth:`~.queue` method must be overridden by the child class. .. seealso:: Tutorial :ref:`tutorial-managedwindow` A tutorial and example on the basic configuration and usage of MangedImageWindow. .. attribute:: plot The `pyqtgraph.PlotItem`_ object for this window. Can be accessed to further customise the plot view programmatically, e.g., display log-log or semi-log axes by default, change axis range, etc. .. _pyqtgraph.PlotItem: http://www.pyqtgraph.org/documentation/graphicsItems/plotitem.html """ def __init__(self, procedure_class, x_axis, y_axis, z_axis=None, inputs=(), displays=(), log_channel='', log_level=logging.INFO, parent=None): super().__init__(parent) app = QtCore.QCoreApplication.instance() app.aboutToQuit.connect(self.quit) self.procedure_class = procedure_class self.inputs = inputs self.displays = displays self.log = logging.getLogger(log_channel) self.log_level = log_level log.setLevel(log_level) self.log.setLevel(log_level) self.x_axis, self.y_axis, self.z_axis = x_axis, y_axis, z_axis self._setup_ui() self._layout() self.setup_im_plot(self.im_plot) self.setup_plot(self.plot) def _setup_ui(self): self.log_widget = LogWidget() self.log.addHandler(self.log_widget.handler) # needs to be in Qt context? log.info("ManagedWindow connected to logging") self.queue_button = QtWidgets.QPushButton('Queue', self) self.queue_button.clicked.connect(self.queue) self.abort_button = QtWidgets.QPushButton('Abort', self) self.abort_button.setEnabled(False) self.abort_button.clicked.connect(self.abort) self.image_widget = ImageWidget(self.procedure_class.DATA_COLUMNS, self.x_axis, self.y_axis, self.z_axis) self.plot_widget = PlotWidget(self.procedure_class.DATA_COLUMNS, self.x_axis, self.y_axis) self.im_plot = self.image_widget.plot self.plot = self.plot_widget.plot self.browser_widget = BrowserWidget( self.procedure_class, self.displays, [self.x_axis, self.y_axis], parent=self ) self.browser_widget.show_button.clicked.connect(self.show_experiments) self.browser_widget.hide_button.clicked.connect(self.hide_experiments) self.browser_widget.clear_button.clicked.connect(self.clear_experiments) self.browser_widget.open_button.clicked.connect(self.open_experiment) self.browser = self.browser_widget.browser self.browser.setContextMenuPolicy(QtCore.Qt.CustomContextMenu) self.browser.customContextMenuRequested.connect(self.browser_item_menu) self.browser.itemChanged.connect(self.browser_item_changed) self.inputs = InputsWidget( self.procedure_class, self.inputs, parent=self ) self.manager = ImageManager(self.plot, self.im_plot, self.browser, log_level=self.log_level, parent=self) self.manager.abort_returned.connect(self.abort_returned) self.manager.queued.connect(self.queued) self.manager.running.connect(self.running) self.manager.finished.connect(self.finished) self.manager.log.connect(self.log.handle) def _layout(self): self.main = QtWidgets.QWidget(self) inputs_dock = QtWidgets.QWidget(self) inputs_vbox = QtWidgets.QVBoxLayout(self.main) hbox = QtWidgets.QHBoxLayout() hbox.setSpacing(10) hbox.setContentsMargins(-1, 6, -1, 6) hbox.addWidget(self.queue_button) hbox.addWidget(self.abort_button) hbox.addStretch() inputs_vbox.addWidget(self.inputs) inputs_vbox.addLayout(hbox) inputs_vbox.addStretch() inputs_dock.setLayout(inputs_vbox) dock = QtWidgets.QDockWidget('Input Parameters') dock.setWidget(inputs_dock) dock.setFeatures(QtWidgets.QDockWidget.NoDockWidgetFeatures) self.addDockWidget(QtCore.Qt.LeftDockWidgetArea, dock) tabs = QtWidgets.QTabWidget(self.main) tabs.addTab(self.image_widget, "Results Image") tabs.addTab(self.plot_widget, "Results Graph") tabs.addTab(self.log_widget, "Experiment Log") splitter = QtWidgets.QSplitter(QtCore.Qt.Vertical) splitter.addWidget(tabs) splitter.addWidget(self.browser_widget) self.image_widget.setMinimumSize(100, 200) self.plot_widget.setMinimumSize(100, 200) vbox = QtWidgets.QVBoxLayout(self.main) vbox.setSpacing(0) vbox.addWidget(splitter) self.main.setLayout(vbox) self.setCentralWidget(self.main) self.main.show() self.resize(1000, 800) def quit(self, evt=None): if self.manager.is_running(): self.abort() self.close() def browser_item_changed(self, item, column): if column == 0: state = item.checkState(0) experiment = self.manager.experiments.with_browser_item(item) if state == 0: self.im_plot.removeItem(experiment.image) self.plot.removeItem(experiment.curve) # QUESTION: will this work?? probably need to modify experiment else: # add regular plot experiment.curve.x = self.plot_widget.plot_frame.x_axis experiment.curve.y = self.plot_widget.plot_frame.y_axis experiment.curve.update() self.plot.addItem(experiment.curve) # add/update image plot experiment.image.update_img() self.im_plot.addItem(experiment.image) def browser_item_menu(self, position): item = self.browser.itemAt(position) if item is not None: experiment = self.manager.experiments.with_browser_item(item) menu = QtWidgets.QMenu(self) # Open action_open = QtWidgets.QAction(menu) action_open.setText("Open Data Externally") action_open.triggered.connect( lambda: self.open_file_externally(experiment.results.data_filename)) menu.addAction(action_open) # Change Color action_change_color = QtWidgets.QAction(menu) action_change_color.setText("Change Color") action_change_color.triggered.connect( lambda: self.change_color(experiment)) menu.addAction(action_change_color) # Remove action_remove = QtWidgets.QAction(menu) action_remove.setText("Remove Graph") if self.manager.is_running(): if self.manager.running_experiment() == experiment: # Experiment running action_remove.setEnabled(False) action_remove.triggered.connect(lambda: self.remove_experiment(experiment)) menu.addAction(action_remove) # Use parameters action_use = QtWidgets.QAction(menu) action_use.setText("Use These Parameters") action_use.triggered.connect( lambda: self.set_parameters(experiment.procedure.parameter_objects())) menu.addAction(action_use) menu.exec_(self.browser.viewport().mapToGlobal(position)) def remove_experiment(self, experiment): reply = QtWidgets.QMessageBox.question(self, 'Remove Graph', "Are you sure you want to remove the graph?", QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.No, QtWidgets.QMessageBox.No) if reply == QtWidgets.QMessageBox.Yes: self.manager.remove(experiment) def show_experiments(self): root = self.browser.invisibleRootItem() for i in range(root.childCount()): item = root.child(i) item.setCheckState(0, QtCore.Qt.Checked) def hide_experiments(self): root = self.browser.invisibleRootItem() for i in range(root.childCount()): item = root.child(i) item.setCheckState(0, QtCore.Qt.Unchecked) def clear_experiments(self): self.manager.clear() def open_experiment(self): dialog = ResultsDialog(self.procedure_class.DATA_COLUMNS, self.x_axis, self.y_axis) if dialog.exec_(): filenames = dialog.selectedFiles() for filename in map(str, filenames): if filename in self.manager.experiments: QtWidgets.QMessageBox.warning(self, "Load Error", "The file %s cannot be opened twice." % os.path.basename( filename)) elif filename == '': return else: results = Results.load(filename) experiment = self.new_experiment(results) experiment.curve.update() # QUESTION: will this work? experiment.image.update_img() experiment.browser_item.progressbar.setValue(100.) self.manager.load(experiment) log.info('Opened data file %s' % filename) def change_color(self, experiment): color = QtWidgets.QColorDialog.getColor( initial=experiment.curve.opts['pen'].color(), parent=self) if color.isValid(): pixelmap = QtWidgets.QPixmap(24, 24) pixelmap.fill(color) experiment.browser_item.setIcon(0, QtWidgets.QIcon(pixelmap)) experiment.curve.setPen(pg.mkPen(color=color, width=2)) def open_file_externally(self, filename): """ Method to open the datafile using an external editor or viewer. Uses the default application to open a datafile of this filetype, but can be overridden by the child class in order to open the file in another application of choice. """ system = platform.system() if (system == 'Windows'): # The empty argument after the start is needed to be able to cope correctly with filenames with spaces proc = subprocess.Popen(['start', '', filename], shell=True) elif (system == 'Linux'): proc = subprocess.Popen(['xdg-open', filename]) elif (system == 'Darwin'): proc = subprocess.Popen(['open', filename]) else: raise Exception("{cls} method open_file_externally does not support {system} OS".format(cls=type(self).__name__,system=system)) def make_procedure(self): if not isinstance(self.inputs, InputsWidget): raise Exception("ManagedWindow can not make a Procedure" " without an InputsWidget type") return self.inputs.get_procedure() def new_curve(self, results, color=None, **kwargs): if color is None: color = pg.intColor(self.browser.topLevelItemCount() % 8) return self.plot_widget.new_curve(results, color=color, **kwargs) def new_image(self, results, **kwargs): return self.image_widget.new_image(results, **kwargs) # TODO: make shure whatever calls this can supply both if needed def new_experiment(self, results, image=None, curve=None): if image is None: image = self.new_image(results) if curve is None: curve = self.new_curve(results) browser_item = BrowserItem(results, curve) return ImageExperiment(results, curve, image, browser_item) def set_parameters(self, parameters): """ This method should be overwritten by the child class. The parameters argument is a dictionary of Parameter objects. The Parameters should overwrite the GUI values so that a user can click "Queue" to capture the same parameters. """ if not isinstance(self.inputs, InputsWidget): raise Exception("ManagedWindow can not set parameters" " without an InputsWidget") self.inputs.set_parameters(parameters) def queue(self): """ Abstract method, which must be overridden by the child class. Implementations must call ``self.manager.queue(experiment)`` and pass an ``experiment`` (:class:`~pymeasure.experiment.experiment.Experiment`) object which contains the :class:`~pymeasure.experiment.results.Results` and :class:`~pymeasure.experiment.procedure.Procedure` to be run. For example: .. code-block:: python def queue(self): filename = unique_filename('results', prefix="data") # from pymeasure.experiment procedure = self.make_procedure() # Procedure class was passed at construction results = Results(procedure, filename) experiment = self.new_experiment(results) self.manager.queue(experiment) """ raise NotImplementedError( "Abstract method ManagedWindow.queue not implemented") def setup_plot(self, plot): """ This method does nothing by default, but can be overridden by the child class in order to set up custom options for the plot This method is called during the constructor, after all other set up has been completed, and is provided as a convenience method to parallel Plotter. :param plot: This window's PlotItem instance. .. _PlotItem: http://www.pyqtgraph.org/documentation/graphicsItems/plotitem.html """ pass def setup_im_plot(self, im_plot): """ This method does nothing by default, but can be overridden by the child class in order to set up custom options for the image plot This method is called during the constructor, after all other set up has been completed, and is provided as a convenience method to parallel Plotter. :param im_plot: This window's ImageItem instance. """ pass def abort(self): self.abort_button.setEnabled(False) self.abort_button.setText("Resume") self.abort_button.clicked.disconnect() self.abort_button.clicked.connect(self.resume) try: self.manager.abort() except: log.error('Failed to abort experiment', exc_info=True) self.abort_button.setText("Abort") self.abort_button.clicked.disconnect() self.abort_button.clicked.connect(self.abort) def resume(self): self.abort_button.setText("Abort") self.abort_button.clicked.disconnect() self.abort_button.clicked.connect(self.abort) if self.manager.experiments.has_next(): self.manager.resume() else: self.abort_button.setEnabled(False) def queued(self, experiment): self.abort_button.setEnabled(True) self.browser_widget.show_button.setEnabled(True) self.browser_widget.hide_button.setEnabled(True) self.browser_widget.clear_button.setEnabled(True) def running(self, experiment): self.browser_widget.clear_button.setEnabled(False) def abort_returned(self, experiment): if self.manager.experiments.has_next(): self.abort_button.setText("Resume") self.abort_button.setEnabled(True) else: self.browser_widget.clear_button.setEnabled(True) def finished(self, experiment): if not self.manager.experiments.has_next(): self.abort_button.setEnabled(False) self.browser_widget.clear_button.setEnabled(True)