class CustomAppExample(CustomApp): # list of dicts enabling the settings tree on the user interface params = [ { 'title': 'Main settings:', 'name': 'main_settings', 'type': 'group', 'children': [{ 'title': 'Save base path:', 'name': 'base_path', 'type': 'browsepath', 'value': config('data_saving', 'h5file', 'save_path') }, { 'title': 'File name:', 'name': 'target_filename', 'type': 'str', 'value': "", 'readonly': True }, { 'title': 'Date:', 'name': 'date', 'type': 'date', 'value': QDate.currentDate() }, { 'title': 'Do something, such as showing data:', 'name': 'do_something', 'type': 'bool', 'value': False }, { 'title': 'Something done:', 'name': 'something_done', 'type': 'led', 'value': False, 'readonly': True }, { 'title': 'Infos:', 'name': 'info', 'type': 'text', 'value': "" }, { 'title': 'push:', 'name': 'push', 'type': 'bool_push', 'value': False }] }, { 'title': 'Other settings:', 'name': 'other_settings', 'type': 'group', 'children': [ { 'title': 'List of stuffs:', 'name': 'list_stuff', 'type': 'list', 'value': 'first', 'limits': ['first', 'second', 'third'], 'tip': 'choose a stuff from the list' }, { 'title': 'List of integers:', 'name': 'list_int', 'type': 'list', 'value': 0, 'limits': [0, 256, 512], 'tip': 'choose a stuff from this int list' }, { 'title': 'one integer:', 'name': 'an_integer', 'type': 'int', 'value': 500, }, { 'title': 'one float:', 'name': 'a_float', 'type': 'float', 'value': 2.7, }, ] }, ] def __init__(self, dockarea): super().__init__(dockarea) # init the object parameters self.raw_data = [] self.setup_ui() def setup_actions(self): ''' subclass method from ActionManager ''' logger.debug('setting actions') self.add_action('quit', 'Quit', 'close2', "Quit program", toolbar=self.toolbar) self.add_action('grab', 'Grab', 'camera', "Grab from camera", checkable=True, toolbar=self.toolbar) self.add_action( 'load', 'Load', 'Open', "Load target file (.h5, .png, .jpg) or data from camera", checkable=False, toolbar=self.toolbar) self.add_action('save', 'Save', 'SaveAs', "Save current data", checkable=False, toolbar=self.toolbar) self.add_action('show', 'Show/hide', 'read2', "Show Hide DAQViewer", checkable=True, toolbar=self.toolbar) logger.debug('actions set') def setup_docks(self): ''' subclass method from CustomApp ''' logger.debug('setting docks') self.dock_settings = Dock('Settings', size=(350, 350)) self.dockarea.addDock(self.dock_settings, 'left') self.dock_settings.addWidget(self.settings_tree, 10) self.dock_logger = Dock("Logger") self.logger_list = QtWidgets.QListWidget() self.logger_list.setMinimumWidth(300) self.dock_logger.addWidget(self.logger_list) self.dockarea.addDock(self.dock_logger, 'bottom', self.dock_settings) # create a dock containing a viewer object, could be 0D, 1D or 2D depending what kind of data one want to plot here a 0D dock_Viewer0D = Dock('Viewer dock', size=(350, 350)) self.dockarea.addDock(dock_Viewer0D, 'right', self.dock_logger) target_widget = QtWidgets.QWidget() self.target_viewer = Viewer0D(target_widget) dock_Viewer0D.addWidget(target_widget) # create 2 docks to display the DAQ_Viewer (one for its settings, one for its viewer) self.dock_detector_settings = Dock("Detector Settings", size=(350, 350)) self.dockarea.addDock(self.dock_detector_settings, 'right', self.dock_settings) self.dock_detector = Dock("Detector Viewer", size=(350, 350)) self.dockarea.addDock(self.dock_detector, 'right', self.dock_detector_settings) # init one daq_viewer object named detector self.detector = DAQ_Viewer(self.dockarea, dock_settings=self.dock_detector_settings, dock_viewer=self.dock_detector, title="A detector", DAQ_type='DAQ0D') # set its type to 'Mock' self.detector.daq_type = 'Mock' # init the detector and wait 1000ms for the completion self.detector.init_det() self.detector.settings.child('main_settings', 'wait_time').setValue(100) QtWidgets.QApplication.processEvents() QThread.msleep(1000) logger.debug('docks are set') def connect_things(self): ''' subclass method from CustomApp ''' logger.debug('connecting things') self.log_signal[str].connect( self.add_log ) # connect together this custom signal with the add_log method self.detector.grab_done_signal.connect(self.data_done) self.connect_action('quit', self.quit_function) self.connect_action('load', self.load_file) self.connect_action('save', self.save_data) self.connect_action('grab', self.detector.grab) self.connect_action('show', self.show_detector) logger.debug('connecting done') def show_detector(self, status): self.dock_detector.setVisible(status) self.dock_detector_settings.setVisible(status) def setup_menu(self): ''' subclass method from CustomApp ''' logger.debug('settings menu') file_menu = self.mainwindow.menuBar().addMenu('File') self.affect_to('quit', file_menu) file_menu.addSeparator() self.affect_to('load', file_menu) self.affect_to('save', file_menu) self.affect_to('quit', file_menu) logger.debug('menu set') def value_changed(self, param): logger.debug(f'calling value_changed with param {param.name()}') if param.name() == 'do_something': if param.value(): self.log_signal.emit('Do something') self.detector.grab_done_signal.connect(self.show_data) self.raw_data = [] # init the data to be finally saved self.settings.child('main_settings', 'something_done').setValue(True) else: self.log_signal.emit('Stop Doing something') self.detector.grab_done_signal.disconnect() self.settings.child('main_settings', 'something_done').setValue(False) logger.debug(f'Value change applied') @Slot(OrderedDict) def data_done(self, data): # print(data) pass @Slot(OrderedDict) def show_data(self, data): """ do stuff with data from the detector if its grab_done_signal has been connected Parameters ---------- data: (OrderedDict) #OrderedDict(name=self.title,x_axis=None,y_axis=None,z_axis=None,data0D=None,data1D=None,data2D=None) """ data0D = [[data['data0D'][key]['data']] for key in data['data0D']] if self.raw_data == []: self.raw_data = data0D else: if len(self.raw_data) != len(data0D): self.raw_data = data0D else: for ind in range(len(data0D)): self.raw_data[ind].append(data0D[ind][0]) self.target_viewer.show_data(data0D) def load_file(self): # init the data browser module widg = QtWidgets.QWidget() self.data_browser = H5Browser(widg) widg.show() def quit_function(self): # close all stuff that need to be self.detector.quit_fun() QtWidgets.QApplication.processEvents() self.mainwindow.close() def run_detector(self): self.detector.ui.grab_pb.click() def save_data(self): try: path = select_file(start_path=self.settings.child( 'main_settings', 'base_path').value(), save=True, ext='h5') if path is not None: # init the file object with an addhoc name given by the user h5saver = H5Saver(save_type='custom') h5saver.init_file(update_h5=True, addhoc_file_path=path) # save all metadata settings_str = ioxml.parameter_to_xml_string(self.settings) settings_str = b'<All_settings>' + settings_str settings_str += ioxml.parameter_to_xml_string( self.detector.settings) + ioxml.parameter_to_xml_string( h5saver.settings) + b'</All_settings>' data_group = h5saver.add_data_group( h5saver.raw_group, group_data_type='data0D', title='data from custom app', settings_as_xml=settings_str) for dat in self.raw_data: channel = h5saver.add_CH_group(data_group) data_dict = dict(data=np.array(dat), x_axis=dict(data=np.linspace( 0, len(dat) - 1, len(dat)), units='pxl')) h5saver.add_data(channel, data_dict=data_dict, scan_type='') st = 'file {:s} has been saved'.format(str(path)) self.add_log(st) self.settings.child('main_settings', 'info').setValue(st) h5saver.close_file() except Exception as e: logger.exception(str(e)) @Slot(str) def add_log(self, txt): """ Add a log to the logger list from the given text log and the current time ================ ========= ====================== **Parameters** **Type** **Description** *txt* string the log to be added ================ ========= ====================== """ now = datetime.datetime.now() new_item = QtWidgets.QListWidgetItem(str(now) + ": " + txt) self.logger_list.addItem(new_item) logger.info(txt)
class CustomApp(QtWidgets.QWidget, QObject): # custom signal that will be fired sometimes. Could be connected to an external object method or an internal method log_signal = pyqtSignal(str) # list of dicts enabling the settings tree on the user interface params = [ { 'title': 'Main settings:', 'name': 'main_settings', 'type': 'group', 'children': [{ 'title': 'Save base path:', 'name': 'base_path', 'type': 'browsepath', 'value': config['data_saving']['h5file']['save_path'] }, { 'title': 'File name:', 'name': 'target_filename', 'type': 'str', 'value': "", 'readonly': True }, { 'title': 'Date:', 'name': 'date', 'type': 'date', 'value': QDate.currentDate() }, { 'title': 'Do something, such as showing data:', 'name': 'do_something', 'type': 'bool', 'value': False }, { 'title': 'Something done:', 'name': 'something_done', 'type': 'led', 'value': False, 'readonly': True }, { 'title': 'Infos:', 'name': 'info', 'type': 'text', 'value': "" }, { 'title': 'push:', 'name': 'push', 'type': 'bool_push', 'value': False }] }, { 'title': 'Other settings:', 'name': 'other_settings', 'type': 'group', 'children': [ { 'title': 'List of stuffs:', 'name': 'list_stuff', 'type': 'list', 'value': 'first', 'values': ['first', 'second', 'third'], 'tip': 'choose a stuff from the list' }, { 'title': 'List of integers:', 'name': 'list_int', 'type': 'list', 'value': 0, 'values': [0, 256, 512], 'tip': 'choose a stuff from this int list' }, { 'title': 'one integer:', 'name': 'an_integer', 'type': 'int', 'value': 500, }, { 'title': 'one float:', 'name': 'a_float', 'type': 'float', 'value': 2.7, }, ] }, ] def __init__(self, dockarea): QLocale.setDefault(QLocale(QLocale.English, QLocale.UnitedStates)) super(CustomApp, self).__init__() if not isinstance(dockarea, DockArea): raise Exception('no valid parent container, expected a DockArea') self.dockarea = dockarea self.mainwindow = dockarea.parent() # init the object parameters self.detector = None self.raw_data = [] # init the user interface self.setup_UI() def setup_UI(self): ########################################### ########################################### # init the docks containing the main widgets ############################################# # this one for the custom application settings dock_settings = Dock('Settings', size=(350, 350)) self.dockarea.addDock(dock_settings, 'left') # create main parameter tree self.settings_tree = ParameterTree() dock_settings.addWidget(self.settings_tree, 10) self.settings_tree.setMinimumWidth(300) # create a Parameter object containing the settings self.settings = Parameter.create(name='Settings', type='group', children=self.params) # load the tree with this parameter object self.settings_tree.setParameters(self.settings, showTop=False) # any change to the tree on the user interface will call the parameter_tree_changed method where all actions will be applied self.settings.sigTreeStateChanged.connect(self.parameter_tree_changed) ################################################################ # create a logger dock where to store info senf from the programm self.dock_logger = Dock("Logger") self.logger_list = QtWidgets.QListWidget() self.logger_list.setMinimumWidth(300) self.dock_logger.addWidget(self.logger_list) self.dockarea.addDock(self.dock_logger, 'bottom', dock_settings) # dock_logger.setVisible(False) # connect together this custom signal with the add_log method self.log_signal[str].connect(self.add_log) ####################################################################################################################### # create a dock containing a viewer object, could be 0D, 1D or 2D depending what kind of data one want to plot here a 0D dock_Viewer0D = Dock('Viewer dock', size=(350, 350)) self.dockarea.addDock(dock_Viewer0D, 'right', self.dock_logger) target_widget = QtWidgets.QWidget() self.target_viewer = Viewer0D(target_widget) dock_Viewer0D.addWidget(target_widget) ################################################################################### # create 2 docks to display the DAQ_Viewer (one for its settings, one for its viewer) dock_detector_settings = Dock("Detector Settings", size=(350, 350)) self.dockarea.addDock(dock_detector_settings, 'right', dock_settings) dock_detector = Dock("Detector Viewer", size=(350, 350)) self.dockarea.addDock(dock_detector, 'right', dock_detector_settings) # init one daq_viewer object named detector self.detector = DAQ_Viewer(self.dockarea, dock_settings=dock_detector_settings, dock_viewer=dock_detector, title="A detector", DAQ_type='DAQ0D') # set its type to 'Mock' control_type = 'Mock' self.detector.ui.Detector_type_combo.setCurrentText(control_type) # init the detector and wait 1000ms for the completion self.detector.ui.IniDet_pb.click() self.detector.settings.child('main_settings', 'wait_time').setValue(100) QtWidgets.QApplication.processEvents() QThread.msleep(1000) self.detector.grab_done_signal.connect(self.data_done) ############################# # create a dock for a DAQ_Move dock_move = Dock("Move module", size=(350, 350)) self.dockarea.addDock(dock_move, 'right', self.dock_logger) move_widget = QtWidgets.QWidget() self.move = DAQ_Move(move_widget) dock_move.addWidget(move_widget) self.move.ui.IniStage_pb.click() QtWidgets.QApplication.processEvents() QThread.msleep(1000) ############################################ # creating a menubar self.menubar = self.mainwindow.menuBar() self.create_menu(self.menubar) # creating a toolbar self.toolbar = QtWidgets.QToolBar() self.create_toolbar() self.mainwindow.addToolBar(self.toolbar) @pyqtSlot(OrderedDict) def data_done(self, data): # print(data) pass @pyqtSlot(QRectF) def update_weighted_settings(self, rect): self.settings.child('weighting_settings', 'x0').setValue(int(rect.x())) self.settings.child('weighting_settings', 'y0').setValue(int(rect.y())) self.settings.child('weighting_settings', 'width').setValue(max([1, int(rect.width())])) self.settings.child('weighting_settings', 'height').setValue(max([1, int(rect.height())])) def parameter_tree_changed(self, param, changes): for param, change, data in changes: path = self.settings.childPath(param) if path is not None: childName = '.'.join(path) else: childName = param.name() if change == 'childAdded': pass elif change == 'value': if param.name() == 'do_something': if param.value(): self.log_signal.emit('Do something') self.detector.grab_done_signal.connect(self.show_data) self.raw_data = [] # init the data to be finally saved self.settings.child('main_settings', 'something_done').setValue(True) else: self.log_signal.emit('Stop Doing something') self.detector.grab_done_signal.disconnect() self.settings.child('main_settings', 'something_done').setValue(False) elif change == 'parent': pass @pyqtSlot(OrderedDict) def show_data(self, data): """ do stuff with data from the detector if its grab_done_signal has been connected Parameters ---------- data: (OrderedDict) #OrderedDict(name=self.title,x_axis=None,y_axis=None,z_axis=None,data0D=None,data1D=None,data2D=None) """ data0D = [[data['data0D'][key]['data']] for key in data['data0D']] if self.raw_data == []: self.raw_data = data0D else: if len(self.raw_data) != len(data0D): self.raw_data = data0D else: for ind in range(len(data0D)): self.raw_data[ind].append(data0D[ind][0]) self.target_viewer.show_data(data0D) def create_menu(self, menubar): """ """ menubar.clear() # %% create file menu file_menu = menubar.addMenu('File') load_action = file_menu.addAction('Load file') load_action.triggered.connect(self.load_file) save_action = file_menu.addAction('Save file') save_action.triggered.connect(self.save_data) file_menu.addSeparator() quit_action = file_menu.addAction('Quit') quit_action.triggered.connect(self.quit_function) settings_menu = menubar.addMenu('Settings') docked_menu = settings_menu.addMenu('Docked windows') action_load = docked_menu.addAction('Load Layout') action_save = docked_menu.addAction('Save Layout') def load_file(self): # init the data browser module widg = QtWidgets.QWidget() self.data_browser = H5Browser(widg) widg.show() def quit_function(self): # close all stuff that need to be self.detector.quit_fun() QtWidgets.QApplication.processEvents() self.mainwindow.close() def create_toolbar(self): iconquit = QtGui.QIcon() iconquit.addPixmap(QtGui.QPixmap(":/icons/Icon_Library/close2.png"), QtGui.QIcon.Normal, QtGui.QIcon.Off) self.quit_action = QtWidgets.QAction(iconquit, "Quit program", None) self.toolbar.addAction(self.quit_action) self.quit_action.triggered.connect(self.quit_function) icon_detector = QtGui.QIcon() icon_detector.addPixmap( QtGui.QPixmap(":/icons/Icon_Library/camera.png"), QtGui.QIcon.Normal, QtGui.QIcon.Off) self.detector_action = QtWidgets.QAction(icon_detector, "Grab from camera", None) self.detector_action.setCheckable(True) self.toolbar.addAction(self.detector_action) self.detector_action.triggered.connect(lambda: self.run_detector()) iconload = QtGui.QIcon() iconload.addPixmap(QtGui.QPixmap(":/icons/Icon_Library/Open.png"), QtGui.QIcon.Normal, QtGui.QIcon.Off) self.loadaction = QtWidgets.QAction( iconload, "Load target file (.h5, .png, .jpg) or data from camera", None) self.toolbar.addAction(self.loadaction) self.loadaction.triggered.connect(self.load_file) iconsave = QtGui.QIcon() iconsave.addPixmap(QtGui.QPixmap(":/icons/Icon_Library/SaveAs.png"), QtGui.QIcon.Normal, QtGui.QIcon.Off) self.saveaction = QtWidgets.QAction(iconsave, "Save current data", None) self.toolbar.addAction(self.saveaction) self.saveaction.triggered.connect(self.save_data) def run_detector(self): self.detector.ui.grab_pb.click() def save_data(self): try: path = gutils.select_file(start_path=self.settings.child( 'main_settings', 'base_path').value(), save=True, ext='h5') if path is not None: # init the file object with an addhoc name given by the user h5saver = H5Saver(save_type='custom') h5saver.init_file(update_h5=True, addhoc_file_path=path) # save all metadata settings_str = ioxml.parameter_to_xml_string(self.settings) settings_str = b'<All_settings>' + settings_str settings_str += ioxml.parameter_to_xml_string( self.detector.settings) + ioxml.parameter_to_xml_string( h5saver.settings) + b'</All_settings>' data_group = h5saver.add_data_group( h5saver.raw_group, group_data_type='data0D', title='data from custom app', settings_as_xml=settings_str) for dat in self.raw_data: channel = h5saver.add_CH_group(data_group) data_dict = dict(data=np.array(dat), x_axis=dict(data=np.linspace( 0, len(dat) - 1, len(dat)), units='pxl')) h5saver.add_data(channel, data_dict=data_dict, scan_type='') st = 'file {:s} has been saved'.format(str(path)) self.add_log(st) self.settings.child('main_settings', 'info').setValue(st) h5saver.close_file() except Exception as e: self.add_log(getLineInfo() + str(e)) @pyqtSlot(str) def add_log(self, txt): """ Add a log to the logger list from the given text log and the current time ================ ========= ====================== **Parameters** **Type** **Description** *txt* string the log to be added ================ ========= ====================== """ now = datetime.datetime.now() new_item = QtWidgets.QListWidgetItem(str(now) + ": " + txt) self.logger_list.addItem(new_item) # #to do # #self.save_parameters.logger_array.append(str(now)+": "+txt) @pyqtSlot(str) def emit_log(self, txt): """ Emit a log-signal from the given log index =============== ======== ======================= **Parameters** **Type** **Description** *txt* string the log to be emitted =============== ======== ======================= """ self.log_signal.emit(txt)