6. Library Reference

• 6.1. Control modules
  • 6.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_log()
      • ControlModule.stop_grab()
      • ControlModule.update_status()
      • ControlModule.initialized_state
      • ControlModule.module_type
      • ControlModule.title
    • ControlModuleUI
      • ControlModuleUI.command_sig
      • ControlModuleUI.do_init()
      • ControlModuleUI.send_init()
  • 6.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.get_scaling_options()
      • DAQ_Viewer.grab()
      • DAQ_Viewer.grab_data()
      • DAQ_Viewer.init_hardware()
      • DAQ_Viewer.init_hardware_ui()
      • 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.show_data()
      • DAQ_Viewer.show_temp_data()
      • DAQ_Viewer.snap()
      • DAQ_Viewer.snapshot()
      • DAQ_Viewer.stop_grab()
      • DAQ_Viewer.take_bkg()
      • DAQ_Viewer.thread_status()
      • DAQ_Viewer.value_changed()
      • 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
  • 6.1.3. DAQ_Detector class
    • DAQ_Detector
      • DAQ_Detector.close()
      • DAQ_Detector.data_ready()
      • DAQ_Detector.grab_data()
      • DAQ_Detector.ini_detector()
      • DAQ_Detector.queue_command()
      • DAQ_Detector.single()
      • DAQ_Detector.update_settings()
  • 6.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.setup_actions()
      • DAQ_Viewer_UI.setup_docks()
      • DAQ_Viewer_UI.update_viewers()
      • DAQ_Viewer_UI.detector_init
  • 6.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.actuator
      • DAQ_Move.initialized_state
      • DAQ_Move.move_done_bool
• 6.2. Main modules
  • 6.2.1. DAQ_Scan module
  • 6.2.2. The CustomApp base class
    • CustomApp
      • CustomApp.connect_things()
      • CustomApp.setup_docks()
      • CustomApp.setup_menu()
      • CustomApp.modules_manager
• 6.3. Utility Modules
  • 6.3.1. Hdf5 module and classes
    • 6.3.1.1. Interacting with hdf5 files
    • 6.3.1.2. Saving Data
    • 6.3.1.3. Browsing Data
  • 6.3.2. Scanner module and classes
    • Scanner
      • Scanner.get_indexes_from_scan_index()
      • Scanner.get_scan_info()
      • Scanner.get_scanner_sub_settings()
      • Scanner.set_scan()
      • Scanner.set_scan_type_and_subtypes()
      • Scanner.value_changed()
      • Scanner.actuators
  • 6.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.child_added()
      • ParameterManager.param_deleted()
      • 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.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
  • 6.3.4. Data Viewers
    • 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()
  • 6.3.5. Plotting utility classes
    • ScanSelector
      • ScanSelector.value_changed()
• 6.4. Utility Libraries
  • 6.4.1. Utility Classes
    • ThreadCommand
      • ThreadCommand.command
      • ThreadCommand.attribute
  • 6.4.2. TCP/IP related methods
    • 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()
  • 6.4.3. Units conversion
    • Ecmrel2Enm()
    • Enm2cmrel()
    • cm2nm()
    • eV2cm()
    • eV2nm()
    • l2w()
    • nm2cm()
    • nm2eV()
  • 6.4.4. Mathematical utilities
    • find_index()
    • ft()
    • ft2()
    • ftAxis()
    • ftAxis_time()
    • gauss1D()
    • gauss2D()
    • ift()
    • ift2()
    • linspace_step()
    • my_moment()
    • odd_even()
  • 6.4.5. Scan utilities
  • 6.4.6. File management
    • select_file()
  • 6.4.7. Data Management
    • DataDimWarning
    • DataIndexWarning
    • DataLengthError
    • DataShapeError
    • DataSizeWarning
    • DataTypeWarning
    • warning
    • AxesManagerSpread
      • AxesManagerSpread.compute_shape_from_axes()
      • AxesManagerSpread.get_axis_from_index()
      • AxesManagerSpread.get_shape_from_index()
    • Axis
      • Axis.create_linear_data()
      • Axis.find_index()
      • Axis.get_data()
      • Axis.get_scale_offset_from_data()
      • Axis.data
      • Axis.index
      • Axis.label
      • Axis.size
      • Axis.units
    • 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.average()
      • DataBase.get_data_index()
      • DataBase.get_dim_from_data()
      • DataBase.get_full_name()
      • DataBase.set_dim()
      • DataBase.data
      • DataBase.dim
      • DataBase.distribution
      • DataBase.length
      • DataBase.shape
      • DataBase.size
      • DataBase.source
    • DataCalculated
    • DataDim
    • DataDistribution
    • DataFromPlugins
    • DataFromRoi
    • DataLowLevel
      • DataLowLevel.name
      • DataLowLevel.timestamp
      • DataLowLevel.name
      • DataLowLevel.timestamp
    • DataRaw
    • DataScan
    • DataSource
    • 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_dim()
      • DataToExport.get_data_from_dims()
      • DataToExport.get_data_from_full_name()
      • DataToExport.get_data_from_name()
      • DataToExport.get_data_from_name_origin()
      • DataToExport.get_data_from_source()
      • DataToExport.get_full_names()
      • DataToExport.get_names()
      • DataToExport.index_from_name_origin()
      • DataToExport.pop()
      • DataToExport.data
    • DataWithAxes
      • DataWithAxes.create_missing_axes()
      • DataWithAxes.deepcopy_with_new_data()
      • DataWithAxes.get_axis_indexes()
      • DataWithAxes.get_dim_from_data_axes()
      • DataWithAxes.get_nav_axes_with_data()
      • DataWithAxes.mean()
      • DataWithAxes.sort_data()
      • DataWithAxes.transpose()
      • DataWithAxes.axes
      • DataWithAxes.nav_indexes
      • DataWithAxes.sig_indexes
    • NavAxis
  • 6.4.8. parameter
    • 6.4.8.1. New Tree items
    • 6.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()
    • 6.4.8.3. Parameter management
      • get_param_from_name()
      • get_param_path()
      • iter_children()
      • iter_children_params()