8.5. pymodaq_gui package

• 8.5.1. pymodaq_gui.examples package
  • 8.5.1.1. pymodaq_gui.examples.action_manager_example module
    • ActionManagerExample
      • ActionManagerExample.log_message()
      • ActionManagerExample.on_action_triggered()
      • ActionManagerExample.setup_actions()
    • main()
  • 8.5.1.2. pymodaq_gui.examples.curves module
    • Curve
      • Curve.boundingRect()
      • Curve.generatePath()
      • Curve.paint()
      • Curve.setBrush()
      • Curve.setData()
      • Curve.setPen()
    • generate_uniform_data()
    • main()
  • 8.5.1.3. pymodaq_gui.examples.custom_viewer module
    • ViewerPointList
      • ViewerPointList.double_click_action()
      • ViewerPointList.setXaxis()
      • ViewerPointList.setYaxis()
      • ViewerPointList.set_point_list()
      • ViewerPointList.set_viewer()
      • ViewerPointList.show_data()
  • 8.5.1.4. pymodaq_gui.examples.data_picker module
    • DataPicker
      • DataPicker.connect_things()
      • DataPicker.double_click_action()
      • DataPicker.setup_actions()
      • DataPicker.setup_docks()
      • DataPicker.setup_menu()
      • DataPicker.setup_table()
      • DataPicker.show_data()
      • DataPicker.params
    • main()
  • 8.5.1.5. pymodaq_gui.examples.icons module
    • Icons
    • main()
  • 8.5.1.6. pymodaq_gui.examples.listwidget module
    • MyListWidget
      • MyListWidget.sizeHint()
    • main()
  • 8.5.1.7. pymodaq_gui.examples.parameter_ex module
    • ParameterEx
      • ParameterEx.limits_changed()
      • ParameterEx.options_changed()
      • ParameterEx.value_changed()
      • ParameterEx.params
    • ScalableGroup
      • ScalableGroup.addNew()
    • main()
• 8.5.2. pymodaq_gui.h5modules package
  • 8.5.2.1. pymodaq_gui.h5modules.browsing module
    • H5Browser
      • H5Browser.add_log()
      • H5Browser.show_help()
      • H5Browser.show_log()
      • H5Browser.add_comments()
      • H5Browser.check_version()
      • H5Browser.connect_things()
      • H5Browser.export_data()
      • H5Browser.get_node_and_plot()
      • H5Browser.get_tree_node_path()
      • H5Browser.load_file()
      • H5Browser.populate_tree()
      • H5Browser.quit_fun()
      • H5Browser.save_file()
      • H5Browser.setup_actions()
      • H5Browser.setup_menu()
      • H5Browser.show_about()
      • H5Browser.show_h5_attributes()
      • H5Browser.show_h5_data()
      • H5Browser.show_pixmaps()
    • View
      • View.add_actions()
      • View.add_base_item()
      • View.add_widget_to_tree()
      • View.clear()
      • View.current_node_path()
      • View.setup_ui()
      • View.h5file_tree
      • View.pixmap_widget
      • View.text_list
      • View.viewer_widget
    • browse_data()
  • 8.5.2.2. pymodaq_gui.h5modules.h5browser module
    • main()
  • 8.5.2.3. pymodaq_gui.h5modules.saving module
    • H5Saver
      • H5Saver.close()
      • H5Saver.emit_new_file()
      • H5Saver.show_file_content()
    • H5SaverBase
      • H5SaverBase.settings
      • H5SaverBase.settings_tree
      • H5SaverBase.find_part_in_path_and_subpath()
      • H5SaverBase.set_current_scan_path()
      • H5SaverBase.get_params_for_save_type()
      • H5SaverBase.get_last_scan()
      • H5SaverBase.get_scan_groups()
      • H5SaverBase.get_scan_index()
      • H5SaverBase.init_file()
      • H5SaverBase.load_file()
      • H5SaverBase.save_file()
      • H5SaverBase.show_settings()
      • H5SaverBase.update_file_paths()
      • H5SaverBase.update_status()
      • H5SaverBase.value_changed()
      • H5SaverBase.params
      • H5SaverBase.settings_name
  • 8.5.2.4. pymodaq_gui.h5modules.utils module
• 8.5.3. pymodaq_gui.managers package
  • 8.5.3.1. pymodaq_gui.managers.action_manager module
    • ActionManager
      • ActionManager.add_action()
      • ActionManager.add_menu()
      • ActionManager.add_toolbar()
      • ActionManager.add_widget()
      • ActionManager.affect_to()
      • ActionManager.connect_action()
      • ActionManager.get_action()
      • ActionManager.get_menu()
      • ActionManager.get_toolbar()
      • ActionManager.has_action()
      • ActionManager.has_menu()
      • ActionManager.has_toolbar()
      • ActionManager.reference_menu()
      • ActionManager.reference_toolbar()
      • ActionManager.set_action_text()
      • ActionManager.set_menu()
      • ActionManager.set_toolbar()
      • ActionManager.setup_actions()
      • ActionManager.actions
      • ActionManager.actions_names
      • ActionManager.is_action_checked
      • ActionManager.is_action_enabled
      • ActionManager.is_action_visible
      • ActionManager.menu
      • ActionManager.menus
      • ActionManager.menus_names
      • ActionManager.set_action_checked
      • ActionManager.set_action_enabled
      • ActionManager.set_action_visible
      • ActionManager.toolbar
      • ActionManager.toolbars
      • ActionManager.toolbars_names
    • QAction
      • QAction.click()
      • QAction.connect_to()
      • QAction.set_icon()
      • QAction.clicked
    • addaction()
    • addwidget()
    • create_icon()
  • 8.5.3.2. pymodaq_gui.managers.config_manager module
    • ConfigManager
      • ConfigManager.title
      • ConfigManager.name
      • ConfigManager.config_path
      • ConfigManager.make_config()
      • ConfigManager.save_config()
      • ConfigManager.set_config_from_file()
      • ConfigManager.set_new_config()
      • ConfigManager.show_config()
      • ConfigManager.name
      • ConfigManager.title
  • 8.5.3.3. pymodaq_gui.managers.parameter_manager module
    • ParameterManager
      • ParameterManager.params
      • ParameterManager.settings_name
      • ParameterManager.settings
      • ParameterManager.settings_tree
      • ParameterManager.tree
      • ParameterManager.create_parameter()
      • ParameterManager.child_added()
      • ParameterManager.limits_changed()
      • ParameterManager.load_settings_slot()
      • ParameterManager.on_toolbar_toggled()
      • ParameterManager.options_changed()
      • ParameterManager.param_deleted()
      • ParameterManager.parameter_tree_changed()
      • ParameterManager.save_settings_slot()
      • ParameterManager.search_settings_slot()
      • ParameterManager.update_settings_slot()
      • ParameterManager.value_changed()
      • ParameterManager.params
      • ParameterManager.settings
      • ParameterManager.settings_name
      • ParameterManager.settings_tree
      • ParameterManager.tree
    • ParameterTreeWidget
      • ParameterTreeWidget.widget
      • ParameterTreeWidget.tree
      • ParameterTreeWidget.toolbar
      • ParameterTreeWidget.collapsible_widget
      • ParameterTreeWidget.activate_search()
      • ParameterTreeWidget.collapse_toolbar()
      • ParameterTreeWidget.setup_actions()
      • ParameterTreeWidget.tree
  • 8.5.3.4. pymodaq_gui.managers.roi_manager module
    • ROIManager
      • ROIManager.roi_format()
      • ROIManager.add_ROI()
      • ROIManager.add_roi_programmatically()
      • ROIManager.clear_ROI()
      • ROIManager.copy_ROI()
      • ROIManager.emit_colors()
      • ROIManager.expand_roi_tree()
      • ROIManager.get_ROI_indexes()
      • ROIManager.get_parameter()
      • ROIManager.get_roi()
      • ROIManager.get_roi_from_index()
      • ROIManager.load_ROI()
      • ROIManager.make_ROI()
      • ROIManager.make_ROI1D()
      • ROIManager.make_ROI2D()
      • ROIManager.remove_ROI()
      • ROIManager.remove_roi_programmatically()
      • ROIManager.roi_tree_changed()
      • ROIManager.save_ROI()
      • ROIManager.set_roi()
      • ROIManager.setupUI()
      • ROIManager.update_roi()
      • ROIManager.update_roi_pos()
      • ROIManager.update_roi_tree()
      • ROIManager.update_use_channel()
      • ROIManager.ROIs
      • ROIManager.color_list
    • ROISaver
      • ROISaver.set_file_roi()
      • ROISaver.set_new_roi()
      • ROISaver.show_rois()
    • ROIScalableGroup
      • ROIScalableGroup.makeChannelsParam()
      • ROIScalableGroup.makeDisplayParam()
      • ROIScalableGroup.makeMathParam()
      • ROIScalableGroup.make_ROIParam1D()
      • ROIScalableGroup.make_ROIParam2D()
      • ROIScalableGroup.addNew()
      • ROIScalableGroup.makeChild()
    • roi_format()
• 8.5.4. pymodaq_gui.parameter package
  • 8.5.4.1. pymodaq_gui.parameter.pymodaq_ptypes package
    • 8.5.4.1.1. pymodaq_gui.parameter.pymodaq_ptypes.bool module
      • BoolPushParameter
      • BoolPushParameterItem
    • 8.5.4.1.2. pymodaq_gui.parameter.pymodaq_ptypes.date module
      • DateParameter
      • DateParameterItem
      • DateTimeParameter
      • DateTimeParameterItem
      • QTimeCustom
      • TimeParameter
      • TimeParameterItem
      • WidgetParameterItem
    • 8.5.4.1.3. pymodaq_gui.parameter.pymodaq_ptypes.filedir module
      • FileDirParameter
      • FileDirParameterItem
      • FileDirWidget
    • 8.5.4.1.4. pymodaq_gui.parameter.pymodaq_ptypes.group module
      • GroupParameter
      • GroupParameterItem
    • 8.5.4.1.5. pymodaq_gui.parameter.pymodaq_ptypes.itemselect module
      • ItemSelect
      • ItemSelectParameter
      • ItemSelectParameterItem
      • ItemSelect_pb
    • 8.5.4.1.6. pymodaq_gui.parameter.pymodaq_ptypes.led module
      • LedParameter
      • LedParameterItem
      • LedPushParameter
      • LedPushParameterItem
    • 8.5.4.1.7. pymodaq_gui.parameter.pymodaq_ptypes.list module
      • Combo_pb
      • ListParameter
      • ListParameterItem
    • 8.5.4.1.8. pymodaq_gui.parameter.pymodaq_ptypes.numeric module
      • NumericParameter
    • 8.5.4.1.9. pymodaq_gui.parameter.pymodaq_ptypes.pixmap module
      • PixmapCheckData
      • PixmapCheckParameter
      • PixmapCheckParameterItem
      • PixmapCheckWidget
      • PixmapParameter
      • PixmapParameterItem
      • main_parameter()
      • main_widget()
    • 8.5.4.1.10. pymodaq_gui.parameter.pymodaq_ptypes.slide module
      • SliderParameter
      • SliderParameterItem
      • SliderSpinBox
    • 8.5.4.1.11. pymodaq_gui.parameter.pymodaq_ptypes.table module
      • TableParameter
      • TableParameterItem
      • TableWidget
    • 8.5.4.1.12. pymodaq_gui.parameter.pymodaq_ptypes.tableview module
      • TableViewCustom
      • TableViewParameter
      • TableViewParameterItem
    • 8.5.4.1.13. pymodaq_gui.parameter.pymodaq_ptypes.text module
      • PlainTextParameterItem
      • PlainTextPbParameter
      • PlainTextWidget
  • 8.5.4.2. pymodaq_gui.parameter.ioxml module
    • XML_file_to_parameter()
    • XML_string_to_parameter()
    • XML_string_to_pobject()
    • add_text_to_elt()
    • dict_from_param()
    • elt_to_dict()
    • parameter_to_xml_file()
    • parameter_to_xml_string()
    • set_dict_from_el()
    • set_txt_from_elt()
    • walk_parameters_to_xml()
    • walk_xml_to_parameter()
    • xml_file_to_parameter_dict()
    • xml_string_to_parameter()
    • xml_string_to_parameter_dict()
  • 8.5.4.3. pymodaq_gui.parameter.utils module
    • ParameterWithPath
      • ParameterWithPath.parameter
      • ParameterWithPath.path
      • ParameterWithPath.deserialize()
      • ParameterWithPath.serialize()
      • ParameterWithPath.value()
      • ParameterWithPath.parameter
      • ParameterWithPath.path
    • change_visibility_all_descendants()
    • compareParameters()
    • compareStructureParameter()
    • compareValuesParameter()
    • filter_parameter_tree()
    • getOpts()
    • getStruct()
    • getValues()
    • get_param_dict_from_name()
    • get_param_from_name()
    • get_param_path()
    • get_widget_from_tree()
    • is_name_in_dict()
    • iter_children()
    • iter_children_params()
    • scroll_linear()
    • scroll_log()
    • set_param_from_param()
  • ParameterTree
• 8.5.5. pymodaq_gui.plotting package
  • 8.5.5.1. pymodaq_gui.plotting.data_viewers package
    • 8.5.5.1.1. pymodaq_gui.plotting.data_viewers.base module
      • ViewerError
      • ViewerBase
      • ViewersEnum
    • 8.5.5.1.2. pymodaq_gui.plotting.data_viewers.viewer module
      • ViewerDispatcher
      • ViewerFactory
      • create_viewer0D()
      • create_viewer1D()
      • create_viewer2D()
      • create_viewerND()
      • get_viewer_enum_from_axes()
    • 8.5.5.1.3. pymodaq_gui.plotting.data_viewers.viewer0D module
      • DataDisplayer
      • View0D
      • Viewer0D
      • main()
      • main_view()
    • 8.5.5.1.4. pymodaq_gui.plotting.data_viewers.viewer1D module
      • DataDisplayer
      • View1D
      • Viewer1D
      • main()
      • main_errors()
      • main_extra_scatter()
      • main_nans()
      • main_random()
      • main_unsorted()
      • main_view1D()
      • main_xy()
    • 8.5.5.1.5. pymodaq_gui.plotting.data_viewers.viewer1Dbasic module
      • Viewer1DBasic
    • 8.5.5.1.6. pymodaq_gui.plotting.data_viewers.viewer2D module
      • Histogrammer
      • ImageDisplayer
      • IsoCurver
      • View2D
      • Viewer2D
      • generate_uniform_data()
      • histogram_factory()
      • image_item_factory()
      • main()
      • main_spread()
      • main_view()
      • plot_data()
      • print_roi_select()
    • 8.5.5.1.7. pymodaq_gui.plotting.data_viewers.viewer2D_basic module
      • Viewer2DBasic
    • 8.5.5.1.8. pymodaq_gui.plotting.data_viewers.viewerND module
      • BaseDataDisplayer
      • SpreadDataDisplayer
      • UniformDataDisplayer
      • ViewerND
      • main()
      • spread_main()
  • 8.5.5.2. pymodaq_gui.plotting.items package
    • 8.5.5.2.1. pymodaq_gui.plotting.items.axis_scaled module
      • AxisItem_Scaled
    • 8.5.5.2.2. pymodaq_gui.plotting.items.crosshair module
      • Crosshair
    • 8.5.5.2.3. pymodaq_gui.plotting.items.image module
      • PymodaqImage
      • SpreadImageItem
      • UniformImageItem
    • 8.5.5.2.4. pymodaq_gui.plotting.items.roi module
      • CircularROI
      • DataDim
      • EllipseROI
      • LinearROI
      • ROI
      • ROIBase
      • ROIBrushable
      • ROIFactory
      • ROIMixin
      • ROIPositionMapper
      • RectROI
      • SimpleRectROI
      • roi_format()
      • translate()
  • 8.5.5.3. pymodaq_gui.plotting.plotter package
    • 8.5.5.3.1. pymodaq_gui.plotting.plotter.plotters package
      • 8.5.5.3.1.1. pymodaq_gui.plotting.plotter.plotters.qt_plotters module
  • 8.5.5.4. pymodaq_gui.plotting.utils package
    • 8.5.5.4.1. pymodaq_gui.plotting.utils.axes_viewer module
      • AxesViewer
    • 8.5.5.4.2. pymodaq_gui.plotting.utils.filter module
      • Filter
      • Filter1DFromCrosshair
      • Filter1DFromRois
      • Filter2DFromCrosshair
      • Filter2DFromRois
      • FourierFilterer
    • 8.5.5.4.3. pymodaq_gui.plotting.utils.lineout module
      • LineoutPlotter
      • curve_item_factory()
    • 8.5.5.4.4. pymodaq_gui.plotting.utils.plot_utils module
      • Data0DWithHistory
      • Point
      • QVector
      • RoiInfo
      • Vector
      • View_cust
      • get_sub_segmented_positions()
      • makeAlphaTriangles()
      • makePolygons()
      • make_dashed_pens()
  • 8.5.5.5. pymodaq_gui.plotting.gant_chart module
  • 8.5.5.6. pymodaq_gui.plotting.image_viewer module
    • Image_Viewer
      • Image_Viewer.fitInView()
      • Image_Viewer.setPhoto()
      • Image_Viewer.wheelEvent()
      • Image_Viewer.zoomFactor()
    • Window
      • Window.handleOpen()
  • 8.5.5.7. pymodaq_gui.plotting.navigator module
    • Navigator
      • Navigator.add_image_data()
      • Navigator.connect_things()
      • Navigator.get_data_from_scan_name()
      • Navigator.list_2D_scans()
      • Navigator.load_data()
      • Navigator.load_image()
      • Navigator.move_at()
      • Navigator.param_deleted()
      • Navigator.remove_image_data()
      • Navigator.set_aspect_ratio()
      • Navigator.set_axes()
      • Navigator.setup_actions()
      • Navigator.setup_ui()
      • Navigator.show_all()
      • Navigator.show_histo()
      • Navigator.show_none()
      • Navigator.show_scans()
      • Navigator.update_h5file()
      • Navigator.update_status()
      • Navigator.value_changed()
      • Navigator.h5saver
      • Navigator.params
      • Navigator.settings_name
  • 8.5.5.8. pymodaq_gui.plotting.widgets module
    • ImageWidget
      • ImageWidget.add_scaled_axis()
      • ImageWidget.getAxis()
      • ImageWidget.setAspectLocked()
      • ImageWidget.setupUI()
    • PlotWidget
      • PlotWidget.legend
      • PlotWidget.view
• 8.5.6. pymodaq_gui.utils package
  • 8.5.6.1. pymodaq_gui.utils.widgets package
    • 8.5.6.1.1. pymodaq_gui.utils.widgets.collapsible_widget module
      • CollapsibleWidget
    • 8.5.6.1.2. pymodaq_gui.utils.widgets.label module
      • LabelWithFont
    • 8.5.6.1.3. pymodaq_gui.utils.widgets.lcd module
      • LCD
    • 8.5.6.1.4. pymodaq_gui.utils.widgets.push module
      • ActionMenu
      • EditPush
      • EditPushInfo
      • EditPushRel
      • PushButtonIcon
      • main()
    • 8.5.6.1.5. pymodaq_gui.utils.widgets.qled module
      • QLED
    • 8.5.6.1.6. pymodaq_gui.utils.widgets.search_lineedit module
      • DemoWindow
      • SearchLineEdit
    • 8.5.6.1.7. pymodaq_gui.utils.widgets.spinbox module
      • QSpinBoxWithShortcut
      • QSpinBox_ro
      • SpinBox
    • 8.5.6.1.8. pymodaq_gui.utils.widgets.table module
      • BooleanDelegate
      • MyStyle
      • SpinBoxDelegate
      • TableModel
      • TableView
    • 8.5.6.1.9. pymodaq_gui.utils.widgets.tree_layout module
      • CustomTree
      • TreeLayout
    • 8.5.6.1.10. pymodaq_gui.utils.widgets.tree_toml module
      • TreeFromToml
    • 8.5.6.1.11. pymodaq_gui.utils.widgets.widget_bkg module
      • WidgetWithBkg
  • 8.5.6.2. pymodaq_gui.utils.custom_app module
    • CustomApp
      • CustomApp.connect_things()
      • CustomApp.do_things_after_ui_setup()
      • CustomApp.quit_fun()
      • CustomApp.setup_docks()
      • CustomApp.setup_menu()
      • CustomApp.setup_ui()
      • CustomApp.dockarea
      • CustomApp.docks
      • CustomApp.mainwindow
      • CustomApp.params
  • 8.5.6.3. pymodaq_gui.utils.dock module
    • Dock
      • Dock.removeWidgets()
      • Dock.setOrientation()
    • DockArea
      • DockArea.addTempArea()
      • DockArea.moveDock()
  • 8.5.6.4. pymodaq_gui.utils.file_io module
    • select_file()
    • select_file_filter()
  • 8.5.6.5. pymodaq_gui.utils.layout module
    • load_layout_state()
    • save_layout_state()
  • 8.5.6.6. pymodaq_gui.utils.list_picker module
    • ListPicker
      • ListPicker.pick_dialog()
  • 8.5.6.7. pymodaq_gui.utils.splash module
    • MySplash
      • MySplash.showMessage()
    • get_splash_sc()
  • 8.5.6.8. pymodaq_gui.utils.utils module
    • clickable()
    • create_nested_menu()
    • exec()
    • first_available_integer()
    • h5tree_to_QTree()
    • mkQApp()
    • pngbinary2Qlabel()
    • set_dark_palette()
    • set_enable_recursive()
    • start_qapplication()
    • widget_to_png_to_bytes()

• 8.5.7. pymodaq_gui.config_saver_loader module
  • ConfigSaverLoader
    • ConfigSaverLoader.load_config()
    • ConfigSaverLoader.save_config()
    • ConfigSaverLoader.base_param
    • ConfigSaverLoader.base_path
  • get_set_roi_path()
• 8.5.8. pymodaq_gui.messenger module
  • dialog()
  • messagebox()
  • show_message()
• 8.5.9. pymodaq_gui.qt_utils module
  • decode_data()
  • setLocale()
• 8.5.10. pymodaq_gui.qvariant module

pymodaq_gui.set_and_check_qt_backend_or_die(config)