8. Library Reference
- 8.1. Control modules
- 8.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
- 8.1.2. DAQ_Viewer class
DAQ_Viewer
DAQ_Viewer.grab_done_signal
DAQ_Viewer.custom_sig
DAQ_Viewer.overshoot_signal
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
- 8.1.3. DAQ_Detector class
- 8.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
- 8.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
- 8.1.6. The DAQ_Move UI class
- 8.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.axis_name
DAQ_Move_base.axis_names
DAQ_Move_base.axis_value
DAQ_Move_base.controller_units
DAQ_Move_base.ispolling
- 8.1.1. ControlModule base classes
- 8.2. Extensions
- 8.3. Utility Modules
- 8.3.1. Hdf5 module and classes
- 8.3.2. Scanner module and classes
- 8.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
- 8.3.4. Data Viewers
- 8.3.5. Plotting utility classes
- 8.4. Utility Libraries
- 8.4.1. Utility Classes
- 8.4.2. TCP/IP related methods
- 8.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()
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()
SocketString
- 8.4.2.2. Custom Sockets to implement PyMoDAQ protocol
- 8.4.2.3. Base classes as TCP server and client
Grabber
MockServer
TCPClient
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()
- 8.4.2.1. Serializing object to bytes and back
- 8.4.3. Units conversion
- 8.4.4. Mathematical utilities
- 8.4.5. Scan utilities
- 8.4.6. File management
- 8.4.7. Data Management
- 8.4.7.1. Axes
- 8.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.as_dte()
DataBase.average()
DataBase.fliplr()
DataBase.flipud()
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.data
DataBase.dim
DataBase.distribution
DataBase.length
DataBase.shape
DataBase.size
DataBase.source
DataCalculated
DataFromPlugins
DataFromRoi
DataRaw
- 8.4.7.3. Data Characteristics
- 8.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
- 8.4.8. parameter