7. Library Reference

• 7.1. Control modules
  • 7.1.1. ControlModule base classes
    • ControlModule
      • ControlModule.init_signal
      • ControlModule.command_hardware
      • ControlModule.command_tcpip
      • ControlModule.quit_signal
      • ControlModule.grab()
      • ControlModule.init_hardware()
      • ControlModule.init_hardware_ui()
      • ControlModule.manage_ui_actions()
      • ControlModule.quit_fun()
      • ControlModule.show_config()
      • ControlModule.show_log()
      • ControlModule.stop_grab()
      • ControlModule.thread_status()
      • ControlModule.update_status()
      • ControlModule.initialized_state
      • ControlModule.module_type
      • ControlModule.title
    • ControlModuleUI
      • ControlModuleUI.command_sig
      • ControlModuleUI.do_init()
      • ControlModuleUI.send_init()
  • 7.1.2. DAQ_Viewer class
    • DAQ_Viewer
      • DAQ_Viewer.grab_done_signal
      • DAQ_Viewer.custom_sig
      • DAQ_Viewer.overshoot_signal
      • DAQ_Viewer.listener_class
      • DAQ_Viewer.append_data()
      • DAQ_Viewer.child_added()
      • DAQ_Viewer.connect_tcp_ip()
      • DAQ_Viewer.daq_type_changed_from_ui()
      • DAQ_Viewer.get_scaling_options()
      • DAQ_Viewer.grab()
      • DAQ_Viewer.grab_data()
      • DAQ_Viewer.init_hardware()
      • DAQ_Viewer.insert_data()
      • DAQ_Viewer.load_data()
      • DAQ_Viewer.param_deleted()
      • DAQ_Viewer.process_tcpip_cmds()
      • DAQ_Viewer.process_ui_cmds()
      • DAQ_Viewer.quit_fun()
      • DAQ_Viewer.save_current()
      • DAQ_Viewer.save_new()
      • DAQ_Viewer.set_data_to_viewers()
      • DAQ_Viewer.setup_continuous_saving()
      • DAQ_Viewer.show_data()
      • DAQ_Viewer.show_temp_data()
      • DAQ_Viewer.snap()
      • DAQ_Viewer.snapshot()
      • DAQ_Viewer.stop()
      • DAQ_Viewer.stop_grab()
      • DAQ_Viewer.take_bkg()
      • DAQ_Viewer.thread_status()
      • DAQ_Viewer.value_changed()
      • DAQ_Viewer.bkg
      • DAQ_Viewer.current_data
      • DAQ_Viewer.daq_type
      • DAQ_Viewer.daq_types
      • DAQ_Viewer.detector
      • DAQ_Viewer.detectors
      • DAQ_Viewer.do_bkg
      • DAQ_Viewer.grab_state
      • DAQ_Viewer.viewer_docks
      • DAQ_Viewer.viewers
      • DAQ_Viewer.viewers_docks
  • 7.1.3. DAQ_Detector class
    • DAQ_Detector
      • DAQ_Detector.detector
      • DAQ_Detector.controller
      • DAQ_Detector.controller_adress
      • DAQ_Detector.close()
      • DAQ_Detector.data_ready()
      • DAQ_Detector.emit_temp_data()
      • DAQ_Detector.grab_data()
      • DAQ_Detector.ini_detector()
      • DAQ_Detector.queue_command()
      • DAQ_Detector.single()
      • DAQ_Detector.update_settings()
  • 7.1.4. The Viewer UI class
    • DAQ_Viewer_UI
      • DAQ_Viewer_UI.command_sig
      • DAQ_Viewer_UI.display_value()
      • DAQ_Viewer_UI.do_init()
      • DAQ_Viewer_UI.connect_things()
      • DAQ_Viewer_UI.do_grab()
      • DAQ_Viewer_UI.do_init()
      • DAQ_Viewer_UI.do_snap()
      • DAQ_Viewer_UI.do_stop()
      • DAQ_Viewer_UI.send_init()
      • DAQ_Viewer_UI.setup_actions()
      • DAQ_Viewer_UI.setup_docks()
      • DAQ_Viewer_UI.update_viewers()
      • DAQ_Viewer_UI.detector_init
  • 7.1.5. The DAQ_Move Class
    • DAQ_Move
      • DAQ_Move.init_signal
      • DAQ_Move.move_done_signal
      • DAQ_Move.bounds_signal
      • DAQ_Move.get_actuator_value()
      • DAQ_Move.get_continuous_actuator_value()
      • DAQ_Move.grab()
      • DAQ_Move.init_hardware_ui()
      • DAQ_Move.move()
      • DAQ_Move.move_abs()
      • DAQ_Move.move_home()
      • DAQ_Move.move_rel()
      • DAQ_Move.quit_fun()
      • DAQ_Move.stop_motion()
      • DAQ_Move.thread_status()
      • DAQ_Move.actuator
      • DAQ_Move.initialized_state
      • DAQ_Move.move_done_bool
  • 7.1.6. The DAQ_Move UI class
    • DAQ_Move_UI
      • DAQ_Move_UI.command_sig
      • DAQ_Move_UI.display_value()
      • DAQ_Move_UI.do_init()
      • DAQ_Move_UI.connect_things()
      • DAQ_Move_UI.do_init()
      • DAQ_Move_UI.send_init()
      • DAQ_Move_UI.set_abs_spinbox_properties()
      • DAQ_Move_UI.set_unit_as_suffix()
      • DAQ_Move_UI.setup_actions()
      • DAQ_Move_UI.setup_docks()
      • DAQ_Move_UI.actuator_init
      • DAQ_Move_UI.move_done
  • 7.1.7. The DAQ_Move Plugin Class
    • DAQ_Move_base
      • DAQ_Move_base.move_done_signal
      • DAQ_Move_base.controller
      • DAQ_Move_base.settings
      • DAQ_Move_base.params
      • DAQ_Move_base.is_multiaxes
      • DAQ_Move_base.current_value
      • DAQ_Move_base.target_value
      • DAQ_Move_base.check_bound()
      • DAQ_Move_base.commit_settings()
      • DAQ_Move_base.emit_status()
      • DAQ_Move_base.emit_value()
      • DAQ_Move_base.get_position_with_scaling()
      • DAQ_Move_base.ini_attributes()
      • DAQ_Move_base.ini_stage_init()
      • DAQ_Move_base.move_done()
      • DAQ_Move_base.poll_moving()
      • DAQ_Move_base.send_param_status()
      • DAQ_Move_base.set_position_relative_with_scaling()
      • DAQ_Move_base.set_position_with_scaling()
      • DAQ_Move_base.update_settings()
      • DAQ_Move_base.user_condition_to_reach_target()
      • DAQ_Move_base.axis_index_key
      • DAQ_Move_base.axis_name
      • DAQ_Move_base.axis_names
      • DAQ_Move_base.axis_unit
      • DAQ_Move_base.axis_units
      • DAQ_Move_base.axis_value
      • DAQ_Move_base.controller_units
      • DAQ_Move_base.epsilon
      • DAQ_Move_base.epsilons
      • DAQ_Move_base.is_master
      • DAQ_Move_base.ispolling
• 7.2. Extensions
  • 7.2.1. DAQ_Scan module
  • 7.2.2. The Bayesian Extension and utilities
    • 7.2.2.1. The Extension module
      • BayesianOptimisation
        • BayesianOptimisation.connect_things()
        • BayesianOptimisation.setup_actions()
        • BayesianOptimisation.setup_docks()
        • BayesianOptimisation.setup_menu()
        • BayesianOptimisation.value_changed()
        • BayesianOptimisation.modules_manager
    • 7.2.2.2. The Base Models
      • BayesianModelGeneric
        • BayesianModelGeneric.convert_input()
        • BayesianModelGeneric.convert_output()
        • BayesianModelGeneric.ini_model()
        • BayesianModelGeneric.runner_initialized()
        • BayesianModelGeneric.update_plots()
        • BayesianModelGeneric.update_settings()
      • BayesianModelDefault
        • BayesianModelDefault.convert_input()
        • BayesianModelDefault.convert_output()
        • BayesianModelDefault.ini_model()
        • BayesianModelDefault.update_settings()
  • 7.2.3. The CustomApp base class
    • CustomApp
      • CustomApp.connect_things()
      • CustomApp.setup_docks()
      • CustomApp.setup_menu()
      • CustomApp.modules_manager
• 7.3. Utility Modules
  • 7.3.1. Hdf5 module and classes
    • 7.3.1.1. Hdf5 backends
      • H5Backend
        • H5Backend.add_group()
        • H5Backend.close_file()
        • H5Backend.create_earray()
        • H5Backend.create_vlarray()
        • H5Backend.define_compression()
        • H5Backend.get_children()
        • H5Backend.get_node_name()
        • H5Backend.get_node_path()
        • H5Backend.get_set_group()
        • H5Backend.is_node_in_group()
    • 7.3.1.2. Low Level saving
      • H5Saver
        • H5Saver.emit_new_file()
      • H5SaverBase
        • H5SaverBase.settings
        • H5SaverBase.settings_tree
        • H5SaverBase.find_part_in_path_and_subpath()
        • H5SaverBase.get_last_scan()
        • H5SaverBase.get_scan_index()
        • H5SaverBase.init_file()
        • H5SaverBase.load_file()
        • H5SaverBase.set_current_scan_path()
        • H5SaverBase.update_file_paths()
        • H5SaverBase.value_changed()
    • 7.3.1.3. High Level saving/loading
      • 7.3.1.3.1. Base data class saver/loader
        • AxisSaverLoader
        • DataManagement
        • DataSaverLoader
        • DataToExportSaver
      • 7.3.1.3.2. Specific data class saver/loader
        • BkgSaver
        • DataEnlargeableSaver
        • DataExtendedSaver
        • DataToExportEnlargeableSaver
        • DataToExportExtendedSaver
        • DataToExportTimedSaver
    • 7.3.1.4. Specialized loading
      • DataLoader
        • DataLoader.get_nav_group()
        • DataLoader.get_node()
        • DataLoader.load_data()
        • DataLoader.walk_nodes()
    • 7.3.1.5. Browsing Data
      • H5Browser
        • H5Browser.add_comments()
        • H5Browser.check_version()
        • H5Browser.export_data()
        • H5Browser.get_tree_node_path()
        • H5Browser.populate_tree()
        • H5Browser.quit_fun()
        • H5Browser.setup_actions()
        • H5Browser.show_h5_data()
      • H5BrowserUtil
        • H5BrowserUtil.export_data()
        • H5BrowserUtil.get_h5_attributes()
        • H5BrowserUtil.get_h5file_scans()
    • 7.3.1.6. Module savers
      • ActuatorSaver
      • DetectorEnlargeableSaver
      • DetectorExtendedSaver
      • DetectorSaver
        • DetectorSaver.add_bkg()
      • LoggerSaver
        • LoggerSaver.add_data()
      • ModuleSaver
        • ModuleSaver.flush()
        • ModuleSaver.get_last_node()
        • ModuleSaver.get_set_node()
      • ScanSaver
        • ScanSaver.get_set_node()
  • 7.3.2. Scanner module and classes
    • ScanType
    • ScanInfo
      • ScanInfo.Nsteps
      • ScanInfo.positions
      • ScanInfo.positions_indexes
      • ScanInfo.axes_unique
      • ScanInfo.kwargs
    • Scanner
      • Scanner.get_indexes_from_scan_index()
      • Scanner.get_scan_info()
      • Scanner.get_scanner_sub_settings()
      • Scanner.positions_at()
      • Scanner.set_scan()
      • Scanner.set_scan_type_and_subtypes()
      • Scanner.value_changed()
      • Scanner.actuators
  • 7.3.3. Managers
    • QAction
    • addaction()
    • ActionManager
      • ActionManager.add_action()
      • ActionManager.add_widget()
      • ActionManager.affect_to()
      • ActionManager.connect_action()
      • ActionManager.get_action()
      • ActionManager.has_action()
      • ActionManager.set_action_text()
      • ActionManager.set_menu()
      • ActionManager.set_toolbar()
      • ActionManager.setup_actions()
      • ActionManager.menu
      • ActionManager.toolbar
    • ParameterManager
      • ParameterManager.params
      • ParameterManager.settings_name
      • ParameterManager.settings
      • ParameterManager.settings_tree
      • ParameterManager.tree
      • ParameterManager.child_added()
      • ParameterManager.load_settings_slot()
      • ParameterManager.param_deleted()
      • ParameterManager.save_settings_slot()
      • ParameterManager.update_settings_slot()
      • ParameterManager.value_changed()
    • ModulesManager
      • ModulesManager.connect_actuators()
      • ModulesManager.connect_detectors()
      • ModulesManager.get_det_data_list()
      • ModulesManager.get_mod_from_name()
      • ModulesManager.get_mods_from_names()
      • ModulesManager.get_names()
      • ModulesManager.get_selected_probed_data()
      • ModulesManager.grab_datas()
      • ModulesManager.move_actuators()
      • ModulesManager.order_positions()
      • ModulesManager.set_actuators()
      • ModulesManager.set_detectors()
      • ModulesManager.test_move_actuators()
      • ModulesManager.value_changed()
      • ModulesManager.Nactuators
      • ModulesManager.Ndetectors
      • ModulesManager.actuators
      • ModulesManager.actuators_all
      • ModulesManager.actuators_name
      • ModulesManager.detectors
      • ModulesManager.detectors_all
      • ModulesManager.detectors_name
      • ModulesManager.modules
      • ModulesManager.modules_all
      • ModulesManager.selected_actuators_name
      • ModulesManager.selected_detectors_name
  • 7.3.4. Data Viewers
    • ViewerBase
      • ViewerBase.view
      • ViewerBase.data_to_export_signal
      • ViewerBase.ROI_changed
      • ViewerBase.crosshair_dragged
      • ViewerBase.crosshair_clicked
      • ViewerBase.sig_double_clicked
      • ViewerBase.status_signal
      • ViewerBase.activate_roi()
      • ViewerBase.add_attributes_from_view()
      • ViewerBase.move_roi_target()
      • ViewerBase.setVisible()
      • ViewerBase.show_data()
      • ViewerBase.show_data_temp()
      • ViewerBase.show_roi_target()
      • ViewerBase.trigger_action()
      • ViewerBase.get_action
      • ViewerBase.has_action
      • ViewerBase.is_action_checked
      • ViewerBase.is_action_visible
      • ViewerBase.roi_target
      • ViewerBase.set_action_checked
      • ViewerBase.set_action_visible
      • ViewerBase.toolbar
      • ViewerBase.viewer_type
    • Viewer0D
    • Viewer1D
      • Viewer1D.activate_roi()
      • Viewer1D.move_roi_target()
      • Viewer1D.set_crosshair_position()
      • Viewer1D.crosshair
      • Viewer1D.roi_manager
      • Viewer1D.roi_target
    • Viewer2D
      • Viewer2D.activate_roi()
      • Viewer2D.get_axes_from_view()
      • Viewer2D.get_data_at()
      • Viewer2D.move_roi_target()
      • Viewer2D.set_crosshair_position()
      • Viewer2D.set_gradient()
      • Viewer2D.set_image_transform()
      • Viewer2D.show_roi()
      • Viewer2D.crosshair
      • Viewer2D.image_widget
      • Viewer2D.roi_manager
      • Viewer2D.roi_target
    • ViewerND
      • ViewerND.setup_actions()
  • 7.3.5. Plotting utility classes
    • LCD
      • LCD.setvalues()
• 7.4. Utility Libraries
  • 7.4.1. Utility Classes
    • ThreadCommand
      • ThreadCommand.command
      • ThreadCommand.attribute
  • 7.4.2. TCP/IP related methods
    • 7.4.2.1. Serializing object to bytes and back
      • DeSerializer
        • DeSerializer.axis_deserialization()
        • DeSerializer.boolean_deserialization()
        • DeSerializer.bytes_to_int()
        • DeSerializer.bytes_to_nd_array()
        • DeSerializer.bytes_to_scalar()
        • DeSerializer.dte_deserialization()
        • DeSerializer.dwa_deserialization()
        • DeSerializer.list_deserialization()
        • DeSerializer.ndarray_deserialization()
        • DeSerializer.scalar_deserialization()
        • DeSerializer.string_deserialization()
        • DeSerializer.type_and_object_deserialization()
      • SerializableTypes
      • Serializer
        • Serializer.axis_serialization()
        • Serializer.dte_serialization()
        • Serializer.dwa_serialization()
        • Serializer.int_to_bytes()
        • Serializer.list_serialization()
        • Serializer.ndarray_serialization()
        • Serializer.object_type_serialization()
        • Serializer.scalar_serialization()
        • Serializer.str_len_to_bytes()
        • Serializer.string_serialization()
        • Serializer.to_bytes()
        • Serializer.type_and_object_serialization()
      • SocketString
        • SocketString.check_received_length()
        • SocketString.get_first_nbytes()
    • 7.4.2.2. Custom Sockets to implement PyMoDAQ protocol
      • Socket
        • Socket.check_received_length()
        • Socket.check_sended()
        • Socket.check_sended_with_serializer()
        • Socket.get_first_nbytes()
    • 7.4.2.3. Base classes as TCP server and client
      • Grabber
        • Grabber.grab_data()
      • MockServer
      • TCPClient
        • TCPClient.get_data()
        • TCPClient.post_init()
        • TCPClient.queue_command()
        • TCPClient.ready_to_read()
        • TCPClient.ready_to_write()
        • TCPClient.ready_with_error()
      • TCPServer
        • TCPServer.close_server()
        • TCPServer.find_socket_type_within_connected_clients()
        • TCPServer.find_socket_within_connected_clients()
        • TCPServer.listen_client()
        • TCPServer.print_status()
        • TCPServer.process_cmds()
        • TCPServer.read_info()
        • TCPServer.select()
        • TCPServer.send_command()
        • TCPServer.set_connected_clients_table()
        • TCPServer.timerEvent()
  • 7.4.3. Units conversion
    • Ecmrel2Enm()
    • Enm2cmrel()
    • cm2nm()
    • eV2cm()
    • eV2nm()
    • l2w()
    • nm2cm()
    • nm2eV()
  • 7.4.4. Mathematical utilities
    • find_index()
    • ft()
    • ft2()
    • ftAxis()
    • ftAxis_time()
    • gauss1D()
    • gauss2D()
    • ift()
    • ift2()
    • linspace_step()
    • my_moment()
    • odd_even()
  • 7.4.5. Scan utilities
  • 7.4.6. File management
    • select_file()
  • 7.4.7. Data Management
    • 7.4.7.1. Axes
      • Axis
        • Axis.create_linear_data()
        • Axis.find_index()
        • Axis.get_data()
        • Axis.get_data_at()
        • Axis.get_scale_offset_from_data()
        • Axis.data
        • Axis.index
        • Axis.label
        • Axis.size
        • Axis.units
    • 7.4.7.2. DataObjects
      • DataBase
        • DataBase.name
        • DataBase.source
        • DataBase.dim
        • DataBase.distribution
        • DataBase.data
        • DataBase.labels
        • DataBase.origin
        • DataBase.shape
        • DataBase.size
        • DataBase.length
        • DataBase.extra_attributes
        • DataBase.abs()
        • DataBase.angle()
        • DataBase.append()
        • DataBase.as_dte()
        • DataBase.average()
        • DataBase.fliplr()
        • DataBase.flipud()
        • DataBase.force_units()
        • DataBase.get_data_index()
        • DataBase.get_dim_from_data()
        • DataBase.get_full_name()
        • DataBase.imag()
        • DataBase.pop()
        • DataBase.real()
        • DataBase.set_dim()
        • DataBase.stack_as_array()
        • DataBase.to_dB()
        • DataBase.to_dict()
        • DataBase.units_as()
        • DataBase.data
        • DataBase.dim
        • DataBase.distribution
        • DataBase.length
        • DataBase.quantities
        • DataBase.shape
        • DataBase.size
        • DataBase.source
        • DataBase.units
      • DataCalculated
      • DataFromPlugins
        • DataFromPlugins.do_plot
        • DataFromPlugins.do_save
      • DataFromRoi
      • DataRaw
    • 7.4.7.3. Data Characteristics
      • DataDim
      • DataDistribution
      • DataSource
    • 7.4.7.4. Union of Data
      • DataToExport
        • DataToExport.name
        • DataToExport.timestamp
        • DataToExport.data
        • DataToExport.affect_name_to_origin_if_none()
        • DataToExport.average()
        • DataToExport.get_data_from_Naxes()
        • DataToExport.get_data_from_attribute()
        • DataToExport.get_data_from_dim()
        • DataToExport.get_data_from_dims()
        • DataToExport.get_data_from_full_name()
        • DataToExport.get_data_from_missing_attribute()
        • DataToExport.get_data_from_name()
        • DataToExport.get_data_from_name_origin()
        • DataToExport.get_data_from_sig_axes()
        • DataToExport.get_data_from_source()
        • DataToExport.get_data_with_naxes_lower_than()
        • DataToExport.get_full_names()
        • DataToExport.get_names()
        • DataToExport.get_origins()
        • DataToExport.index_from_name_origin()
        • DataToExport.merge_as_dwa()
        • DataToExport.plot()
        • DataToExport.pop()
        • DataToExport.data
  • 7.4.8. parameter
    • 7.4.8.1. New Tree items
    • 7.4.8.2. Parameter and XML
      • XML_file_to_parameter()
      • XML_string_to_parameter()
      • add_text_to_elt()
      • dict_from_param()
      • elt_to_dict()
      • parameter_to_xml_file()
      • parameter_to_xml_string()
      • set_txt_from_elt()
      • walk_parameters_to_xml()
      • walk_xml_to_parameter()
    • 7.4.8.3. Parameter management
      • get_param_from_name()
      • get_param_path()
      • iter_children()
      • iter_children_params()