8. Library Reference

• 8.1. Control modules
  • 8.1.1. ControlModule base classes
    • ControlModule
      • ControlModule.grab()
      • ControlModule.init_hardware()
      • ControlModule.init_hardware_ui()
      • ControlModule.manage_ui_actions()
      • ControlModule.quit_fun()
      • ControlModule.raise_timeout()
      • ControlModule.stop_grab()
      • ControlModule.stop_module()
      • ControlModule.thread_status()
      • ControlModule.update_status()
      • ControlModule.initialized_state
      • ControlModule.module_type
      • ControlModule.title
    • HardwareWorkerBase
      • HardwareWorkerBase.queue_command()
      • HardwareWorkerBase.update_settings()
    • ControlModuleUI
      • ControlModuleUI.close()
      • ControlModuleUI.do_init()
      • ControlModuleUI.enable_actions()
      • ControlModuleUI.send_init()
      • ControlModuleUI.show_settings()
      • ControlModuleUI.update_init_icon()
  • 8.1.2. DAQ_Viewer class
    • DAQ_Viewer
      • DAQ_Viewer.listener_class
      • DAQ_Viewer.append_data()
      • DAQ_Viewer.grab()
      • DAQ_Viewer.grab_data()
      • DAQ_Viewer.process_leco_commands()
      • DAQ_Viewer.process_ui_cmds()
      • DAQ_Viewer.save_current()
      • 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.stop_module()
      • DAQ_Viewer.take_bkg()
      • DAQ_Viewer.thread_status()
      • DAQ_Viewer.bkg
      • DAQ_Viewer.current_data
      • DAQ_Viewer.daq_type
      • DAQ_Viewer.daq_types
      • DAQ_Viewer.detector
      • DAQ_Viewer.do_bkg
      • DAQ_Viewer.grab_state
      • DAQ_Viewer.viewer_docks
      • DAQ_Viewer.viewers
      • DAQ_Viewer.viewers_docks
  • 8.1.3. DetectorWorker class
    • DetectorWorker
      • DetectorWorker.close()
      • DetectorWorker.data_ready()
      • DetectorWorker.emit_temp_data()
      • DetectorWorker.grab_data()
      • DetectorWorker.ini_detector()
      • DetectorWorker.ini_hardware()
      • DetectorWorker.queue_command()
      • DetectorWorker.single()
  • 8.1.4. The Viewer UI class
    • DAQ_Viewer_UI
      • DAQ_Viewer_UI.do_grab()
      • DAQ_Viewer_UI.do_init()
      • DAQ_Viewer_UI.do_snap()
      • DAQ_Viewer_UI.do_stop()
      • DAQ_Viewer_UI.detector_init
  • 8.1.5. The DAQ_Move Class
    • DAQ_Move
      • DAQ_Move.get_actuator_value()
      • DAQ_Move.get_continuous_actuator_value()
      • 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
    • DAQMoveUI
      • DAQMoveUI.do_init()
      • DAQMoveUI.set_abs_spinbox_properties()
      • DAQMoveUI.set_ui_type()
      • DAQMoveUI.set_unit_as_suffix()
      • DAQMoveUI.set_unit_prefix()
      • DAQMoveUI.move_done
  • 8.1.7. The ActuatorWorker class
    • ActuatorWorker
      • ActuatorWorker.Move_Stoped()
      • ActuatorWorker.check_position()
      • ActuatorWorker.close()
      • ActuatorWorker.get_actuator_value()
      • ActuatorWorker.ini_hardware()
      • ActuatorWorker.ini_stage()
      • ActuatorWorker.move_done()
      • ActuatorWorker.move_home()
      • ActuatorWorker.queue_command()
      • ActuatorWorker.stop_motion()
  • 8.1.8. The DAQ_Move Plugin Class
    • DAQ_Move_base
      • DAQ_Move_base.get_class_axis_names()
      • DAQ_Move_base.absolute_difference_condition_to_reach_target()
      • DAQ_Move_base.check_bound()
      • DAQ_Move_base.commit_settings()
      • DAQ_Move_base.emit_value()
      • DAQ_Move_base.get_position_with_scaling()
      • DAQ_Move_base.ini_attributes()
      • DAQ_Move_base.ini_stage()
      • DAQ_Move_base.ini_stage_init()
      • DAQ_Move_base.move_done()
      • DAQ_Move_base.poll_moving()
      • DAQ_Move_base.set_position_relative_with_scaling()
      • DAQ_Move_base.set_position_with_scaling()
      • DAQ_Move_base.stop_motion()
      • 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
• 8.2. Extensions
  • 8.2.1. DAQ_Scan module
  • 8.2.2. The Bayesian Extension and utilities
    • 8.2.2.1. The Extension module
      • BayesianOptimization
        • BayesianOptimization.ini_custom_attributes()
        • BayesianOptimization.update_after_actuators_changed()
        • BayesianOptimization.update_prediction_function()
        • BayesianOptimization.value_changed()
    • 8.2.2.2. The Base Models
      • OptimizerModelGeneric
        • OptimizerModelGeneric.convert_input()
        • OptimizerModelGeneric.convert_output()
        • OptimizerModelGeneric.has_fitness_observable()
        • OptimizerModelGeneric.ini_model()
        • OptimizerModelGeneric.runner_initialized()
        • OptimizerModelGeneric.update_plots()
        • OptimizerModelGeneric.update_settings()
      • OptimizerModelDefault
        • OptimizerModelDefault.convert_input()
        • OptimizerModelDefault.convert_output()
        • OptimizerModelDefault.has_fitness_observable()
  • 8.2.3. The Sequencer Extension
    • 8.2.3.1. The Extension
      • Sequencer
        • Sequencer.connect_things()
        • Sequencer.setup_actions()
        • Sequencer.setup_docks_and_widgets()
        • Sequencer.setup_menus_and_toolbars()
        • Sequencer.update_sequence_name()
      • SequenceWorker
      • Sequence
        • Sequence.connect_things()
        • Sequence.set_log_callback()
        • Sequence.setup_actions()
        • Sequence.setup_docks_and_widgets()
        • Sequence.setup_menus_and_toolbars()
    • 8.2.3.2. Elements
      • SeqEltBase
        • SeqEltBase.deserialize()
        • SeqEltBase.from_dict()
        • SeqEltBase.serialize()
        • SeqEltBase.check_set_is_valid()
        • SeqEltBase.child()
        • SeqEltBase.child_by_index()
        • SeqEltBase.create_widget()
        • SeqEltBase.do_things_with_dashboard()
        • SeqEltBase.do_things_with_parent_sequence()
        • SeqEltBase.execute()
        • SeqEltBase.from_dict_custom()
        • SeqEltBase.get_elt_from_id()
        • SeqEltBase.get_elts()
        • SeqEltBase.get_elts_as_str()
        • SeqEltBase.get_ids()
        • SeqEltBase.initialize_element()
        • SeqEltBase.save_data()
        • SeqEltBase.set_parent()
        • SeqEltBase.size_hint()
        • SeqEltBase.to_dict()
        • SeqEltBase.to_dict_custom()
        • SeqEltBase.parent
      • SeqEltFactory
        • SeqEltFactory.get_seq_elt()
        • SeqEltFactory.register_elt()
      • ElementError
      • StateElt
        • StateElt.check_set_is_valid()
        • StateElt.filter_state_wrt_manager()
        • StateElt.from_dict_custom()
        • StateElt.to_dict_custom()
      • MoveElt
        • MoveElt.check_set_is_valid()
        • MoveElt.from_dict_custom()
        • MoveElt.to_dict_custom()
      • GrabElt
        • GrabElt.check_set_is_valid()
        • GrabElt.filter_selected_wrt_manager()
        • GrabElt.from_dict_custom()
        • GrabElt.to_dict_custom()
      • WaitElt
        • WaitElt.from_dict_custom()
        • WaitElt.to_dict_custom()
      • RepeatElt
        • RepeatElt.check_set_is_valid()
        • RepeatElt.from_dict_custom()
        • RepeatElt.to_dict_custom()
      • ScannerElt
        • ScannerElt.check_set_is_valid()
        • ScannerElt.from_dict_custom()
        • ScannerElt.to_dict_custom()
      • ChoiceElt
        • ChoiceElt.check_set_is_valid()
        • ChoiceElt.from_dict_custom()
        • ChoiceElt.set_go_to_true()
        • ChoiceElt.to_dict_custom()
      • SequenceElt
        • SequenceElt.check_set_is_valid()
        • SequenceElt.do_things_with_parent_sequence()
        • SequenceElt.from_dict_custom()
        • SequenceElt.get_sequences()
        • SequenceElt.get_sequences_name()
        • SequenceElt.to_dict_custom()
    • 8.2.3.3. Choice models
      • ChoiceModelBase
        • ChoiceModelBase.check_set_is_valid()
        • ChoiceModelBase.from_dict()
        • ChoiceModelBase.to_dict()
        • ChoiceModelBase.updated_module_manager()
      • get_choice_models()
      • ChoiceModelFactory
        • ChoiceModelFactory.get_model()
        • ChoiceModelFactory.register_choice()
      • ThresholdChoiceModel
        • ThresholdChoiceModel.check_set_is_valid()
        • ThresholdChoiceModel.from_dict()
        • ThresholdChoiceModel.to_dict()
        • ThresholdChoiceModel.updated_module_manager()
      • UserInput
      • TrueChoiceModel
      • FalseChoiceModel
    • 8.2.3.4. State machine
      • CompositeState
      • TrackedTransition
        • TrackedTransition.is_child_of()
      • ValueTransition
      • InterruptState
  • 8.2.4. The Ramping Extension
    • 8.2.4.1. The Extension
      • RampExtension
        • RampExtension.connect_things()
        • RampExtension.setup_actions()
        • RampExtension.setup_docks_and_widgets()
        • RampExtension.setup_menus_and_toolbars()
        • RampExtension.value_changed()
      • RampingWorker
    • 8.2.4.2. Ramp and data saving
      • RampGenerator
      • RampSaver
    • 8.2.4.3. Histogram
      • H5Histogramming
        • H5Histogramming.check_min_axis_size()
        • H5Histogramming.get_selection()
        • H5Histogramming.update_settings_from_file()
        • H5Histogramming.live
      • HistogramProcessor
        • HistogramProcessor.average_data_over_indexes()
      • InfoForHistogram
  • 8.2.5. The CustomApp base class
• 8.3. Utility Modules
  • 8.3.1. Hdf5 module and classes
    • 8.3.1.1. Hdf5 backends
    • 8.3.1.2. Low Level saving
    • 8.3.1.3. SWMR utilities
      • 8.3.1.3.1. Typical usage
    • 8.3.1.4. High Level saving/loading
      • 8.3.1.4.1. Base data class saver/loader
      • 8.3.1.4.2. Specific data class saver/loader
    • 8.3.1.5. Specialized loading
    • 8.3.1.6. Browsing Data
    • 8.3.1.7. Module savers
      • ActuatorSaver
      • DetectorEnlargeableSaver
      • DetectorExtendedSaver
      • DetectorSaver
        • DetectorSaver.add_bkg()
        • DetectorSaver.filter_data()
        • DetectorSaver.filter_data_wrt_settings()
      • LoggerSaver
        • LoggerSaver.add_data()
      • ModuleSaver
        • ModuleSaver.flush()
        • ModuleSaver.get_last_node()
        • ModuleSaver.get_set_node()
        • ModuleSaver.update_after_h5changed()
      • ScanSaver
        • ScanSaver.update_after_h5changed()
  • 8.3.2. Scanner module and classes
    • ScanType
    • ScanInfo
    • 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.to_dict()
      • Scanner.actuators
      • Scanner.actuators_all
  • 8.3.3. GUI Managers
  • 8.3.4. Module Managers
    • ModulesManager
      • ModulesManager.get_names()
      • ModulesManager.add_modules()
      • ModulesManager.connect_actuators()
      • ModulesManager.connect_and_move_actuators()
      • ModulesManager.connect_detectors()
      • ModulesManager.forget_callback()
      • ModulesManager.get_det_data_list()
      • ModulesManager.get_missing_actuators()
      • ModulesManager.get_missing_detectors()
      • ModulesManager.get_mod_from_name()
      • ModulesManager.get_mods_from_names()
      • ModulesManager.get_probed_data_full_names()
      • ModulesManager.get_random_id()
      • ModulesManager.grab_data()
      • ModulesManager.grab_datas()
      • ModulesManager.move_actuators()
      • ModulesManager.move_actuators_with_callback()
      • ModulesManager.on_hardware_initialization()
      • ModulesManager.order_positions()
      • ModulesManager.probe_actuators()
      • ModulesManager.probe_detectors()
      • ModulesManager.set_actuators()
      • ModulesManager.set_actuators_from_names()
      • ModulesManager.set_detectors()
      • ModulesManager.set_detectors_from_names()
      • ModulesManager.test_move_actuators()
      • 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.5. DashBoard Managers
    • ExperimentManager
    • StateManager
  • 8.3.6. Data Viewers
  • 8.3.7. Plotting utility classes
    • ScanSelector
• 8.4. Utility Libraries
  • 8.4.1. Utility Classes
  • 8.4.2. Hardware Discovery
    • 8.4.2.1. Base cache class
      • HardwareCache
        • HardwareCache.invalidate_cache()
        • HardwareCache.list_resources()
    • 8.4.2.2. VISA resources
      • invalidate_cache()
      • list_resource_aliases()
      • list_resources()
      • list_serial_resources()
    • 8.4.2.3. Serial ports
      • invalidate_cache()
      • list_port_descriptions()
      • list_resources()
    • 8.4.2.4. Package helpers
      • invalidate_all_caches()
  • 8.4.3. Units conversion
  • 8.4.4. Mathematical utilities
  • 8.4.5. File management
  • 8.4.6. Data Management
    • 8.4.6.1. Axes
    • 8.4.6.2. DataObjects
      • DataActuator
      • DataFromPlugins
    • 8.4.6.3. Data Characteristics
    • 8.4.6.4. Union of Data
  • 8.4.7. parameter
    • 8.4.7.1. New Tree items
    • 8.4.7.2. Parameter and XML
    • 8.4.7.3. Parameter management
• 8.5. pymodaq_utils package
  • 8.5.1. pymodaq_utils.resources package
    • 8.5.1.1. pymodaq_utils.resources.hatch_build_plugins module
      • update_metadata_from_toml()
  • 8.5.2. pymodaq_utils.serialize package
    • 8.5.2.1. pymodaq_utils.serialize.factory module
    • 8.5.2.2. pymodaq_utils.serialize.mysocket module
      • Socket
        • Socket.check_receiving()
        • Socket.check_sended()
        • Socket.check_sended_with_serializer()
      • SocketString
        • SocketString.check_received_length()
        • SocketString.get_first_nbytes()
        • SocketString.to_bytes()
    • 8.5.2.3. pymodaq_utils.serialize.serializer module
    • 8.5.2.4. pymodaq_utils.serialize.serializer_legacy module
      • DeSerializer
        • DeSerializer.from_b64_string()
        • DeSerializer.axis_deserialization()
        • DeSerializer.boolean_deserialization()
        • DeSerializer.bytes_deserialization()
        • DeSerializer.dte_deserialization()
        • DeSerializer.dwa_deserialization()
        • DeSerializer.get_message_length()
        • DeSerializer.list_deserialization()
        • DeSerializer.ndarray_deserialization()
        • DeSerializer.parameter_deserialization()
        • DeSerializer.scalar_deserialization()
        • DeSerializer.string_deserialization()
        • DeSerializer.type_and_object_deserialization()
      • Serializer
        • Serializer.axis_serialization()
        • Serializer.bytes_serialization()
        • Serializer.dte_serialization()
        • Serializer.dwa_serialization()
        • Serializer.list_serialization()
        • Serializer.ndarray_serialization()
        • Serializer.object_type_serialization()
        • Serializer.scalar_serialization()
        • Serializer.string_serialization()
        • Serializer.to_b64_string()
        • Serializer.to_bytes()
        • Serializer.type_and_object_serialization()
    • 8.5.2.5. pymodaq_utils.serialize.utils module
      • bytes_to_int()
      • bytes_to_nd_array()
      • bytes_to_scalar()
      • bytes_to_string()
      • get_int_from_bytes()
      • int_to_bytes()
      • split_nbytes()
      • str_len_to_bytes()
      • str_to_bytes()
  • 8.5.3. pymodaq_utils.abstract module
    • ABCMeta
    • DummyAttribute
    • abstract_attribute()
  • 8.5.4. pymodaq_utils.array_manipulation module
    • are_elements_contiguous()
    • arglimit()
    • crop_array_to_axis()
    • crop_vector_to_axis()
    • find()
    • find_index()
    • find_rising_edges()
    • interp1D()
    • limit()
    • linspace_this_image()
    • linspace_this_vect()
    • marginals()
    • max_ind()
    • min_ind()
    • random_step()
    • rescale()
  • 8.5.5. pymodaq_utils.categorizing module
    • add_category_layers()
    • categorize_items()
    • find_last_index()
  • 8.5.6. pymodaq_utils.config module
    • ConfigError
    • BaseConfig
      • BaseConfig.dict_to_add_to_user()
      • BaseConfig.get()
      • BaseConfig.get_children()
      • BaseConfig.load()
      • BaseConfig.save()
      • BaseConfig.to_dict()
      • BaseConfig.to_xml_string()
      • BaseConfig.config_name
      • BaseConfig.config_path
      • BaseConfig.config_template_path
      • BaseConfig.system_config_path
    • CacheConfig
    • Config
      • Config.dict_to_add_to_user()
      • Config.config_name
      • Config.config_template_path
    • ConfigSingleton
    • GlobalConfig
      • GlobalConfig.register()
      • GlobalConfig.add_config()
      • GlobalConfig.get()
      • GlobalConfig.save()
      • GlobalConfig.to_dict()
      • GlobalConfig.config_name
      • GlobalConfig.config_path
      • GlobalConfig.system_config_path
    • check_config()
    • copy_template_config()
    • create_toml_from_dict()
    • deep_update()
    • get_config_file()
    • get_set_config_dir()
    • get_set_local_dir()
    • get_set_log_path()
    • get_set_path()
    • getitem_recursive()
    • load_system_config_and_update_from_user()
    • recursive_iterable_flattening()
    • replace_file_extension()
    • replace_item_in_list()
  • 8.5.7. pymodaq_utils.enums module
    • BaseEnum
      • BaseEnum.names()
      • BaseEnum.to_dict()
      • BaseEnum.to_dict_value()
      • BaseEnum.values()
    • StrEnum
      • StrEnum.names()
      • StrEnum.values()
    • enum_checker()
  • 8.5.8. pymodaq_utils.environment module
    • EnvironmentBackupManager
      • EnvironmentBackupManager.save_backup()
    • PythonEnvironment
      • PythonEnvironment.from_file()
      • PythonEnvironment.from_freeze()
      • PythonEnvironment.date()
      • PythonEnvironment.extend()
      • PythonEnvironment.remove()
      • PythonEnvironment.save()
      • PythonEnvironment.DATE_FORMAT
    • guess_virtual_environment()
  • 8.5.9. pymodaq_utils.factory module
    • BuilderBase
    • ObjectFactory
      • ObjectFactory.create()
      • ObjectFactory.get_class()
      • ObjectFactory.register()
      • ObjectFactory.keys_function()
      • ObjectFactory.builders
      • ObjectFactory.keys
  • 8.5.10. pymodaq_utils.help module
    • get_help_text()
  • 8.5.11. pymodaq_utils.logger module
    • get_base_logger()
    • get_module_name()
    • set_logger()
  • 8.5.12. pymodaq_utils.math_utils module
    • LSqEllipse
      • LSqEllipse.fit()
      • LSqEllipse.parameters()
      • LSqEllipse.center
      • LSqEllipse.height
      • LSqEllipse.phi
      • LSqEllipse.width
    • find_common_index()
    • find_index()
    • flatten()
    • ft()
    • ft2()
    • ftAxis()
    • ftAxis_time()
    • gauss1D()
    • gauss2D()
    • get_si_prefix()
    • greater2n()
    • ift()
    • ift2()
    • is_power_of_two()
    • linspace_step()
    • linspace_step_N()
    • make_test_ellipse()
    • my_moment()
    • normalize()
    • normalize_to()
    • odd_even()
    • rotate2D()
    • wrap()
  • 8.5.13. pymodaq_utils.mysocket module
    • Socket
      • Socket.accept()
      • Socket.bind()
      • Socket.check_received_length()
      • Socket.check_sended()
      • Socket.close()
      • Socket.connect()
      • Socket.get_first_nbytes()
      • Socket.getsockname()
      • Socket.listen()
      • Socket.recv()
      • Socket.send()
      • Socket.sendall()
      • Socket.socket
  • 8.5.14. pymodaq_utils.packages module
    • extract_authors_from_description()
    • get_check_repo()
    • get_entrypoints()
    • get_metadata_from_json()
    • get_package_metadata()
    • get_pymodaq_specifier()
    • get_pypi_package_list()
    • get_pypi_pymodaq()
    • post_error()
  • 8.5.15. pymodaq_utils.plugin_checks module
    • PluginLoadError
    • CheckResult
      • CheckResult.failing()
      • CheckResult.findings
      • CheckResult.item
      • CheckResult.ok
      • CheckResult.problems
      • CheckResult.warnings
    • PluginModule
      • PluginModule.class_name
      • PluginModule.import_path
      • PluginModule.kind
      • PluginModule.module_name
      • PluginModule.name
      • PluginModule.package
      • PluginModule.prefix
    • PluginReport
      • PluginReport.format()
      • PluginReport.to_dict()
      • PluginReport.fail_on
      • PluginReport.failures
      • PluginReport.ok
      • PluginReport.package
      • PluginReport.results
      • PluginReport.strict_imports
      • PluginReport.todos
    • check_move_class()
    • check_package_layout()
    • check_package_sources()
    • check_plugin_file()
    • check_plugin_module()
    • check_plugin_package()
    • check_viewer_class()
    • find_plugin_modules()
    • guess_package_name()
    • is_installed()
    • load_plugin_class()
    • main()
    • resolve_file()
    • resolve_target()
  • 8.5.16. pymodaq_utils.plugin_rules module
    • Finding
      • Finding.format()
      • Finding.code
      • Finding.column
      • Finding.hint
      • Finding.line
      • Finding.location
      • Finding.message
      • Finding.path
      • Finding.severity
    • Severity
      • Severity.ERROR
      • Severity.TODO
      • Severity.WARNING
    • check_file_names()
    • check_leftovers()
    • check_package_sources()
    • check_plugin_source()
    • check_pyproject()
    • colorize()
    • is_valid_unit()
    • package_root()
    • project_root()
    • syntax_error_finding()
    • use_color()
  • 8.5.17. pymodaq_utils.plugin_scaffold module
    • create_instrument()
    • find_package_folder()
    • main()
  • 8.5.18. pymodaq_utils.plugin_testing module
  • 8.5.19. pymodaq_utils.singleton module
    • Singleton
      • Singleton.unregister()
  • 8.5.20. pymodaq_utils.units module
    • E_J2eV()
    • Ecmrel2Enm()
    • Enm2cmrel()
    • cm2nm()
    • eV2E_J()
    • eV2cm()
    • eV2nm()
    • eV2radfs()
    • l2w()
    • nm2cm()
    • nm2eV()
  • 8.5.21. pymodaq_utils.utils module
    • JsonConverter
      • JsonConverter.istrusted()
      • JsonConverter.json2object()
      • JsonConverter.object2json()
      • JsonConverter.trusted_types()
    • ThreadCommand
      • ThreadCommand.deserialize()
      • ThreadCommand.serialize()
      • ThreadCommand.args
      • ThreadCommand.attribute
      • ThreadCommand.command
      • ThreadCommand.kwargs
    • caller_name()
    • capitalize()
    • check_vals_in_iterable()
    • count_lines()
    • elt_as_first_element()
    • elt_as_first_element_dicts()
    • ensure_ndarray()
    • find_dict_if_matched_key_val()
    • find_dict_in_list_from_key_val()
    • find_dicts_in_list_from_key_val()
    • find_keys_from_val()
    • find_object_if_matched_attr_name_val()
    • find_objects_in_list_from_attr_name_val()
    • format_dir_path()
    • getLineInfo()
    • get_entrypoints()
    • get_module_path()
    • get_new_file_name()
    • get_version()
    • is_64bits()
    • read_binary_and_deserialize()
    • recursive_find_expr_in_files()
    • recursive_find_files()
    • recursive_find_files_extension()
    • remove_spaces()
    • rint()
    • timer()
    • uncapitalize()
    • zeros_aligned()
  • 8.5.22. pymodaq_utils.warnings module
    • deprecation_msg()
    • user_warning()
• 8.6. pymodaq_gui package
  • 8.6.1. pymodaq_gui.editor package
    • 8.6.1.1. pymodaq_gui.editor.monaco module
      • FileStatus
        • FileStatus.path
        • FileStatus.unsaved
      • MonacoApp
        • MonacoApp.check_python_syntax_valid()
        • MonacoApp.add_file()
        • MonacoApp.add_text_to_display()
        • MonacoApp.close_editor()
        • MonacoApp.connect_things()
        • MonacoApp.create_file()
        • MonacoApp.create_monaco_widget()
        • MonacoApp.display_file_text()
        • MonacoApp.do_things_after_ui_setup()
        • MonacoApp.do_things_on_file_changed()
        • MonacoApp.get_editor_from_tab_index()
        • MonacoApp.get_files_cache()
        • MonacoApp.highlight_tab()
        • MonacoApp.is_file_and_editor_content_same()
        • MonacoApp.load_file()
        • MonacoApp.quit_fun()
        • MonacoApp.remove_file()
        • MonacoApp.run_file()
        • MonacoApp.save_copy_file_as()
        • MonacoApp.save_file()
        • MonacoApp.save_file_as()
        • MonacoApp.setup_actions()
        • MonacoApp.setup_docks_and_widgets()
        • MonacoApp.setup_menus_and_toolbars()
        • MonacoApp.unsaved_tabname()
        • MonacoApp.current_editor
        • MonacoApp.current_file
        • MonacoApp.files_path
        • MonacoApp.local_files_path
        • MonacoApp.local_path
        • MonacoApp.monaco_widget
        • MonacoApp.run_signal
        • MonacoApp.staticMetaObject
      • MonacoWithFile
        • MonacoWithFile.set_saved()
        • MonacoWithFile.set_unsaved()
        • MonacoWithFile.file_status
        • MonacoWithFile.saved
        • MonacoWithFile.staticMetaObject
        • MonacoWithFile.unsaved
      • Redirect
        • Redirect.flush()
        • Redirect.write()
      • Runner
        • Runner.do_subprocess()
        • Runner.staticMetaObject
      • main()
    • editor_main_loader()
  • 8.6.2. pymodaq_gui.examples package
    • 8.6.2.1. pymodaq_gui.examples.action_checked_icons module
      • MyWidget
        • MyWidget.setup_actions()
        • MyWidget.setup_ui()
      • main()
    • 8.6.2.2. pymodaq_gui.examples.action_manager_example module
      • ActionManagerExample
        • ActionManagerExample.log_message()
        • ActionManagerExample.on_action_triggered()
        • ActionManagerExample.setup_actions()
        • ActionManagerExample.staticMetaObject
      • main()
    • 8.6.2.3. pymodaq_gui.examples.curves module
      • Curve
        • Curve.boundingRect()
        • Curve.generatePath()
        • Curve.paint()
        • Curve.setBrush()
        • Curve.setData()
        • Curve.setPen()
        • Curve.staticMetaObject
      • generate_uniform_data()
      • main()
    • 8.6.2.4. 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()
        • ViewerPointList.staticMetaObject
    • 8.6.2.5. pymodaq_gui.examples.data_picker module
      • DataPicker
        • DataPicker.connect_things()
        • DataPicker.double_click_action()
        • DataPicker.setup_actions()
        • DataPicker.setup_docks_and_widgets()
        • DataPicker.setup_menus_and_toolbars()
        • DataPicker.setup_table()
        • DataPicker.show_data()
        • DataPicker.params
        • DataPicker.staticMetaObject
      • main()
    • 8.6.2.6. pymodaq_gui.examples.function_plotter module
      • FunctionPlotter
        • FunctionPlotter.connect_things()
        • FunctionPlotter.plot()
        • FunctionPlotter.plot_all()
        • FunctionPlotter.plot_timer()
        • FunctionPlotter.setup_actions()
        • FunctionPlotter.setup_docks_and_widgets()
        • FunctionPlotter.setup_menus_and_toolbars()
        • FunctionPlotter.value_changed()
        • FunctionPlotter.functions
        • FunctionPlotter.params
        • FunctionPlotter.staticMetaObject
      • main()
    • 8.6.2.7. pymodaq_gui.examples.listwidget module
      • MyListWidget
        • MyListWidget.sizeHint()
        • MyListWidget.staticMetaObject
      • main()
    • 8.6.2.8. pymodaq_gui.examples.material_icon_ex module
      • Icons
      • main()
    • 8.6.2.9. pymodaq_gui.examples.menu_button module
    • 8.6.2.10. pymodaq_gui.examples.parameter_ex module
      • ParameterEx
        • ParameterEx.limits_changed()
        • ParameterEx.options_changed()
        • ParameterEx.value_changed()
        • ParameterEx.params
      • ScalableGroup
        • ScalableGroup.addNew()
        • ScalableGroup.staticMetaObject
      • create_text_with_pattern_parameter()
      • main()
    • 8.6.2.11. pymodaq_gui.examples.pattern_completer_demo module
      • PatternCompleterDemo
        • PatternCompleterDemo.staticMetaObject
      • create_basic_example()
      • create_code_editor_example()
      • create_dynamic_updates_example()
      • create_global_config_example()
      • create_multiple_patterns_example()
      • create_per_pattern_config_example()
      • create_table_delegate_example()
      • create_word_wrap_example()
    • 8.6.2.12. pymodaq_gui.examples.saving_loading module
      • DataGenerator
        • DataGenerator.generate_data()
        • DataGenerator.queue_command()
        • DataGenerator.start()
        • DataGenerator.stop()
        • DataGenerator.command_signal
        • DataGenerator.data_signal
        • DataGenerator.refresh_time
        • DataGenerator.staticMetaObject
        • DataGenerator.stopped
      • DataProcessor
        • DataProcessor.do_process_data()
        • DataProcessor.staticMetaObject
      • MySaverLoader
        • MySaverLoader.connect_things()
        • MySaverLoader.do_things_after_ui_setup()
        • MySaverLoader.get_app_toolbars()
        • MySaverLoader.setup_actions()
        • MySaverLoader.setup_docks_and_widgets()
        • MySaverLoader.setup_menus_and_toolbars()
        • MySaverLoader.value_changed()
        • MySaverLoader.data_generator
        • MySaverLoader.h5_base_group_name
        • MySaverLoader.module_and_data_saver
        • MySaverLoader.params
        • MySaverLoader.show_h5file_statusbar_widgets
        • MySaverLoader.show_workflow_actions
        • MySaverLoader.staticMetaObject
        • MySaverLoader.viewer
      • MySaverLoaderWorker
        • MySaverLoaderWorker.process_data()
        • MySaverLoaderWorker.send_data()
        • MySaverLoaderWorker.show_data()
        • MySaverLoaderWorker.app
        • MySaverLoaderWorker.has_data_processor
        • MySaverLoaderWorker.processor_worker
        • MySaverLoaderWorker.staticMetaObject
      • main()
    • 8.6.2.13. pymodaq_gui.examples.shared_ui module
      • MyApp
        • MyApp.connect_things()
        • MyApp.setup_actions()
        • MyApp.setup_docks_and_widgets()
        • MyApp.setup_menus_and_toolbars()
        • MyApp.params
        • MyApp.staticMetaObject
      • main()
    • 8.6.2.14. pymodaq_gui.examples.sticky_menu_demo module
      • StickyMenuDemo
        • StickyMenuDemo.connect_things()
        • StickyMenuDemo.setup_actions()
        • StickyMenuDemo.setup_docks_and_widgets()
        • StickyMenuDemo.setup_menus_and_toolbars()
        • StickyMenuDemo.params
        • StickyMenuDemo.staticMetaObject
      • main()
    • 8.6.2.15. pymodaq_gui.examples.theming_demo module
      • 8.6.2.15.1. PyMoDAQ Theming Demo — Status Color Palette + Material Icon Toolbar
        • 8.6.2.15.1.1. One theme control drives two different rebuild strategies
      • ThemingDemo
        • ThemingDemo.closeEvent()
        • ThemingDemo.staticMetaObject
      • main()
    • 8.6.2.16. pymodaq_gui.examples.view2D_parts module
      • generate_uniform_data()
      • main()
  • 8.6.3. pymodaq_gui.h5modules package
    • 8.6.3.1. pymodaq_gui.h5modules.browsing module
      • H5Browser
        • H5Browser.add_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.refresh_file()
        • H5Browser.save_file()
        • H5Browser.setup_actions()
        • H5Browser.setup_docks_and_widgets()
        • H5Browser.setup_menus_and_toolbars()
        • H5Browser.show_h5_attributes()
        • H5Browser.show_h5_data()
        • H5Browser.show_pixmaps()
        • H5Browser.data_node_signal
        • H5Browser.staticMetaObject
        • H5Browser.status_signal
      • 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.item_clicked_sig
        • View.item_double_clicked_sig
        • View.pixmap_widget
        • View.staticMetaObject
        • View.text_list
        • View.viewer_widget
      • browse_data()
    • 8.6.3.2. pymodaq_gui.h5modules.h5browser module
      • main()
    • 8.6.3.3. pymodaq_gui.h5modules.saving module
      • H5Saver
        • H5Saver.close()
        • H5Saver.open_file_dialog_result()
        • H5Saver.show_file_content()
        • H5Saver.file_changed_sig
        • H5Saver.new_file_sig
        • H5Saver.staticMetaObject
        • H5Saver.status_sig
      • H5SaverBase
        • 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.fill_value
        • H5SaverBase.params
        • H5SaverBase.settings_name
    • 8.6.3.4. pymodaq_gui.h5modules.utils module
  • 8.6.4. pymodaq_gui.managers package
    • 8.6.4.1. pymodaq_gui.managers.settings package
      • 8.6.4.1.1. pymodaq_gui.managers.settings.settings_manager module
        • SettingsManager
        • get_set_settings_path()
      • 8.6.4.1.2. pymodaq_gui.managers.settings.subentries module
        • SubEntryError
        • SettingsEntryHandler
        • SubEntry
        • SubEntryHandler
        • SubEntryHandlerFactory
        • SubEntryHandlerTypes
      • 8.6.4.1.3. pymodaq_gui.managers.settings.utils module
        • EntryActions
        • ParameterDelegate
        • SettingsManagerModel
        • SettingsManagerParameterTree
        • SettingsManagerTableView
    • 8.6.4.2. pymodaq_gui.managers.action_manager module
      • ActionManager
        • ActionManager.add_action()
        • ActionManager.add_menu()
        • ActionManager.add_toolbar()
        • ActionManager.add_widget()
        • ActionManager.affect_to()
        • ActionManager.apply_toolbar_style()
        • 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.remove_action()
        • ActionManager.set_action_text()
        • ActionManager.set_menu()
        • ActionManager.set_toolbar()
        • ActionManager.setup_actions()
        • ActionManager.setup_toolbar_style_menu()
        • 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
        • QAction.staticMetaObject
      • ToolbarStyleChecks
        • ToolbarStyleChecks.sync()
        • ToolbarStyleChecks.staticMetaObject
      • ToolbarStyleSignaller
        • ToolbarStyleSignaller.staticMetaObject
        • ToolbarStyleSignaller.style_changed
      • WidgetActionProxy
        • WidgetActionProxy.isVisible()
        • WidgetActionProxy.setVisible()
        • WidgetActionProxy.action
        • WidgetActionProxy.staticMetaObject
        • WidgetActionProxy.widget
      • addaction()
      • addwidget()
      • get_toolbar_button_style()
    • 8.6.4.3. pymodaq_gui.managers.config_manager module
      • ConfigManager
        • ConfigManager.make_config()
        • ConfigManager.save_config()
        • ConfigManager.set_config_from_file()
        • ConfigManager.set_new_config()
        • ConfigManager.show_config()
        • ConfigManager.name
        • ConfigManager.title
    • 8.6.4.4. pymodaq_gui.managers.h5manager module
      • FileAction
        • FileAction.CLOSE_FILE
        • FileAction.LOAD
        • FileAction.NEW_FILE
        • FileAction.OPEN_FILE
        • FileAction.SAVE
        • FileAction.SHOW_FILE
        • FileAction.SHOW_SETTINGS
      • FileStatus
        • FileStatus.CLOSED
        • FileStatus.NEW
        • FileStatus.NO_FILE
        • FileStatus.REOPENED
        • FileStatus.REOPENED_ANOTHER
      • H5Manager
        • H5Manager.close_file()
        • H5Manager.create_file_toolbar_and_menu()
        • H5Manager.create_new_file()
        • H5Manager.flush()
        • H5Manager.get_h5saver()
        • H5Manager.insert_h5stuff_status()
        • H5Manager.load_file()
        • H5Manager.open_file()
        • H5Manager.save_file()
        • H5Manager.set_file_open()
        • H5Manager.set_swmr_status()
        • H5Manager.settings()
        • H5Manager.settings_tree()
        • H5Manager.show_file_content()
        • H5Manager.show_settings()
        • H5Manager.update_file_status_led()
        • H5Manager.command_sig
        • H5Manager.current_folder
        • H5Manager.file_loaded_signal
        • H5Manager.file_open_signal
        • H5Manager.h5saver
        • H5Manager.staticMetaObject
        • H5Manager.statusbar
    • 8.6.4.5. pymodaq_gui.managers.manager_base module
      • ListView
        • ListView.staticMetaObject
      • ManagerActions
        • ManagerActions.COPY
        • ManagerActions.DELETE
        • ManagerActions.EXECUTE
        • ManagerActions.LABEL_EXTERNAL
        • ManagerActions.LIST
        • ManagerActions.LIST_EXTERNAL
        • ManagerActions.NEW
        • ManagerActions.OPEN
        • ManagerActions.RELOAD
        • ManagerActions.SAVE
      • ManagerBase
        • ManagerBase.format_subentries()
        • ManagerBase.close_subentries_display()
        • ManagerBase.connect_things_base()
        • ManagerBase.copy_entry()
        • ManagerBase.create_entry()
        • ManagerBase.create_slot_from_file()
        • ManagerBase.delete_entry()
        • ManagerBase.do_things_for_new_creation()
        • ManagerBase.enable_actions()
        • ManagerBase.entry_path_from_name()
        • ManagerBase.execute_current_entry()
        • ManagerBase.execute_entry()
        • ManagerBase.force_show()
        • ManagerBase.get_action_from_file()
        • ManagerBase.get_action_list()
        • ManagerBase.get_entry_folder()
        • ManagerBase.get_external_toolbar_menu()
        • ManagerBase.get_sync_combo_entry()
        • ManagerBase.list_managed_entries()
        • ManagerBase.list_managed_entries_path()
        • ManagerBase.quit_fun()
        • ManagerBase.save_check()
        • ManagerBase.save_entries()
        • ManagerBase.save_new_history_entry()
        • ManagerBase.set_entry_applied()
        • ManagerBase.setup_actions_base()
        • ManagerBase.setup_docks_and_widgets()
        • ManagerBase.setup_ui()
        • ManagerBase.show()
        • ManagerBase.show_subentries()
        • ManagerBase.sync_entries_with()
        • ManagerBase.update_action_list()
        • ManagerBase.update_actions_connection()
        • ManagerBase.update_entry()
        • ManagerBase.update_execute_action_tooltip()
        • ManagerBase.update_menu()
        • ManagerBase.applied_entry
        • ManagerBase.applied_entry_name
        • ManagerBase.default_entry_name
        • ManagerBase.deleted_entry
        • ManagerBase.entries
        • ManagerBase.entries_filepath
        • ManagerBase.entry
        • ManagerBase.entry_applied
        • ManagerBase.entry_extension
        • ManagerBase.entry_filepath
        • ManagerBase.entry_type
        • ManagerBase.execute_action_checkable
        • ManagerBase.icon_name
        • ManagerBase.manager_name
        • ManagerBase.new_entry
        • ManagerBase.splash_subentries
        • ManagerBase.staticMetaObject
        • ManagerBase.subentries_model
        • ManagerBase.updated_entry
      • ManagerSubEntriesModel
        • ManagerSubEntriesModel.data()
        • ManagerSubEntriesModel.rowCount()
        • ManagerSubEntriesModel.set_status()
        • ManagerSubEntriesModel.colors
        • ManagerSubEntriesModel.staticMetaObject
        • ManagerSubEntriesModel.status
      • Menu
        • Menu.EXTERNAL
        • Menu.MAIN
      • SubEntriesSplash
        • SubEntriesSplash.mousePressEvent()
        • SubEntriesSplash.setModel()
        • SubEntriesSplash.show_splash()
        • SubEntriesSplash.staticMetaObject
      • Toolbar
        • Toolbar.EXTERNAL
        • Toolbar.MAIN
    • 8.6.4.6. pymodaq_gui.managers.parameter_manager module
      • ParameterManager
        • ParameterManager.create_parameter()
        • ParameterManager.child_added()
        • ParameterManager.clear_settings_slot()
        • ParameterManager.connect_tree()
        • ParameterManager.disconnect_tree()
        • ParameterManager.limits_changed()
        • ParameterManager.load_settings_slot()
        • ParameterManager.menu_changed()
        • ParameterManager.on_toolbar_toggled()
        • ParameterManager.options_changed()
        • ParameterManager.param_deleted()
        • ParameterManager.parameter_tree_changed()
        • ParameterManager.save_settings_slot()
        • ParameterManager.search_settings_slot()
        • ParameterManager.set_settings()
        • ParameterManager.update_settings_slot()
        • ParameterManager.value_changed()
        • ParameterManager.params
        • ParameterManager.settings
        • ParameterManager.settings_name
        • ParameterManager.settings_tree
        • ParameterManager.tree
      • ParameterTreeWidget
        • ParameterTreeWidget.activate_search()
        • ParameterTreeWidget.collapse_toolbar()
        • ParameterTreeWidget.setup_actions()
        • ParameterTreeWidget.tree
    • 8.6.4.7. pymodaq_gui.managers.roi_viewer_manager module
      • ROIMeta
      • ROIParameterManager
        • ROIParameterManager.clear_settings_slot()
        • ROIParameterManager.set_settings()
        • ROIParameterManager.rois_setting
      • ROIScalableGroup
        • ROIScalableGroup.addNew()
        • ROIScalableGroup.staticMetaObject
      • ROIViewerManager
        • ROIViewerManager.add_roi_programmatically()
        • ROIViewerManager.child_added()
        • ROIViewerManager.copy_ROI()
        • ROIViewerManager.create_and_add()
        • ROIViewerManager.emit_colors()
        • ROIViewerManager.expand_roi_tree()
        • ROIViewerManager.get_ROI_indexes()
        • ROIViewerManager.get_roi_from_index()
        • ROIViewerManager.menu_changed()
        • ROIViewerManager.param_deleted()
        • ROIViewerManager.remove_ROI()
        • ROIViewerManager.remove_roi_programmatically()
        • ROIViewerManager.set_roi()
        • ROIViewerManager.update_use_channel()
        • ROIViewerManager.value_changed()
        • ROIViewerManager.ROIs
        • ROIViewerManager.color_signal
        • ROIViewerManager.new_ROI_signal
        • ROIViewerManager.params
        • ROIViewerManager.remove_ROI_signal
        • ROIViewerManager.roi_changed
        • ROIViewerManager.roiwidget
        • ROIViewerManager.staticMetaObject
        • ROIViewerManager.view_box
    • 8.6.4.8. pymodaq_gui.managers.runner_thread_manager module
      • DataForProcessor
        • DataForProcessor.node_path
      • ThreadWorker
        • ThreadWorker.data_processed_signal
        • ThreadWorker.data_to_process_signal
        • ThreadWorker.data_to_save_signal
        • ThreadWorker.n_jobs_done_signal
        • ThreadWorker.name
        • ThreadWorker.params
        • ThreadWorker.staticMetaObject
        • ThreadWorker.worker_setting_name
      • WorkerThreadManager
        • WorkerThreadManager.create_thread_for_worker()
        • WorkerThreadManager.exit_runner_thread()
        • WorkerThreadManager.exit_worker_thread()
        • WorkerThreadManager.exit_worker_threads()
        • WorkerThreadManager.get_last_name()
        • WorkerThreadManager.get_thread()
        • WorkerThreadManager.get_worker()
        • WorkerThreadManager.start_thread()
        • WorkerThreadManager.current_name
        • WorkerThreadManager.n_jobs
        • WorkerThreadManager.runner_thread
        • WorkerThreadManager.staticMetaObject
        • WorkerThreadManager.worker
        • WorkerThreadManager.worker_thread
        • WorkerThreadManager.worker_threads
        • WorkerThreadManager.workers
      • get_thread_params()
  • 8.6.5. pymodaq_gui.parameter package
    • 8.6.5.1. pymodaq_gui.parameter.pymodaq_ptypes package
      • 8.6.5.1.1. pymodaq_gui.parameter.pymodaq_ptypes.action_led module
        • ActionLedParameter
        • ActionLedParameterItem
        • ActionLedWidget
      • 8.6.5.1.2. pymodaq_gui.parameter.pymodaq_ptypes.bool module
        • BoolPushParameter
        • BoolPushParameterItem
      • 8.6.5.1.3. pymodaq_gui.parameter.pymodaq_ptypes.date module
        • DateParameter
        • DateParameterItem
        • DateTimeParameter
        • DateTimeParameterItem
        • QTimeCustom
        • TimeParameter
        • TimeParameterItem
        • WidgetParameterItem
      • 8.6.5.1.4. pymodaq_gui.parameter.pymodaq_ptypes.filedir module
        • FileDirParameter
        • FileDirParameterItem
        • FileDirWidget
      • 8.6.5.1.5. pymodaq_gui.parameter.pymodaq_ptypes.group module
        • GroupParameter
        • GroupParameterItem
      • 8.6.5.1.6. pymodaq_gui.parameter.pymodaq_ptypes.itemselect module
        • ItemSelect
        • ItemSelectParameter
        • ItemSelectParameterItem
        • ItemSelect_pb
      • 8.6.5.1.7. pymodaq_gui.parameter.pymodaq_ptypes.led module
        • LedParameter
        • LedParameterItem
        • LedPushParameter
        • LedPushParameterItem
        • MultistateLedParameter
        • MultistateLedParameterItem
      • 8.6.5.1.8. pymodaq_gui.parameter.pymodaq_ptypes.list module
        • Combo_pb
        • ListParameter
        • ListParameterItem
      • 8.6.5.1.9. pymodaq_gui.parameter.pymodaq_ptypes.numeric module
        • NumericParameter
      • 8.6.5.1.10. pymodaq_gui.parameter.pymodaq_ptypes.pixmap module
        • PixmapCheckData
        • PixmapCheckParameter
        • PixmapCheckParameterItem
        • PixmapCheckWidget
        • PixmapParameter
        • PixmapParameterItem
        • main_parameter()
        • main_widget()
      • 8.6.5.1.11. pymodaq_gui.parameter.pymodaq_ptypes.slide module
        • SliderParameter
        • SliderParameterItem
        • SliderSpinBox
      • 8.6.5.1.12. pymodaq_gui.parameter.pymodaq_ptypes.table module
        • TableParameter
        • TableParameterItem
        • TableWidget
      • 8.6.5.1.13. pymodaq_gui.parameter.pymodaq_ptypes.tableview module
        • TableViewCustom
        • TableViewParameter
        • TableViewParameterItem
      • 8.6.5.1.14. pymodaq_gui.parameter.pymodaq_ptypes.text module
        • PlainTextParameterItem
        • PlainTextPbParameter
        • PlainTextWidget
      • 8.6.5.1.15. pymodaq_gui.parameter.pymodaq_ptypes.text_pattern module
        • PatternParameter
        • PatternParameterItem
    • 8.6.5.2. pymodaq_gui.parameter.ioxml module
      • XML_file_to_parameter()
      • XML_string_to_parameter()
      • XML_string_to_pobject()
      • add_text_to_elt()
      • basic_serialization()
      • 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.6.5.3. pymodaq_gui.parameter.utils module
      • ParameterWithPath
        • 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()
      • tree_change_blocker()
    • ParameterTree
      • ParameterTree.staticMetaObject
  • 8.6.6. pymodaq_gui.plotting package
    • 8.6.6.1. pymodaq_gui.plotting.data_viewers package
      • 8.6.6.1.1. pymodaq_gui.plotting.data_viewers.base module
        • ViewerError
        • ViewerBase
        • ViewersEnum
      • 8.6.6.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.6.6.1.3. pymodaq_gui.plotting.data_viewers.viewer0D module
        • DataDisplayer
        • View0D
        • Viewer0D
        • main()
        • main_view()
      • 8.6.6.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.6.6.1.5. pymodaq_gui.plotting.data_viewers.viewer1Dbasic module
        • Viewer1DBasic
      • 8.6.6.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.6.6.1.7. pymodaq_gui.plotting.data_viewers.viewer2D_basic module
        • Viewer2DBasic
      • 8.6.6.1.8. pymodaq_gui.plotting.data_viewers.viewerND module
        • BaseDataDisplayer
        • SpreadDataDisplayer
        • UniformDataDisplayer
        • ViewerND
        • main()
        • spread_main()
    • 8.6.6.2. pymodaq_gui.plotting.items package
      • 8.6.6.2.1. pymodaq_gui.plotting.items.axis_scaled module
        • AxisItemScaled
      • 8.6.6.2.2. pymodaq_gui.plotting.items.crosshair module
        • Crosshair
      • 8.6.6.2.3. pymodaq_gui.plotting.items.image module
        • PymodaqImage
        • SpreadImageItem
        • UniformImageItem
      • 8.6.6.2.4. pymodaq_gui.plotting.items.roi module
        • CircularROI
        • EllipseROI
        • LinearROI
        • ROI
        • ROIBase
        • ROIBrushable
        • ROIDim
        • ROIFactory
        • ROIPositionMapper
        • RectROI
        • RoiInfo
        • SimpleRectROI
        • roi_format()
        • translate()
      • 8.6.6.2.5. pymodaq_gui.plotting.items.roi_sync module
        • ROIParameterOptions
        • ROISync
        • RoiParameter
    • 8.6.6.3. pymodaq_gui.plotting.plotter package
      • 8.6.6.3.1. pymodaq_gui.plotting.plotter.plotters package
        • 8.6.6.3.1.1. pymodaq_gui.plotting.plotter.plotters.qt_plotters module
    • 8.6.6.4. pymodaq_gui.plotting.utils package
      • 8.6.6.4.1. pymodaq_gui.plotting.utils.axes_viewer module
        • AxesViewer
      • 8.6.6.4.2. pymodaq_gui.plotting.utils.filter module
        • Filter
        • Filter1DFromCrosshair
        • Filter1DFromRois
        • Filter2DFromCrosshair
        • Filter2DFromRois
        • FourierFilterer
      • 8.6.6.4.3. pymodaq_gui.plotting.utils.lineout module
        • LineoutPlotter
        • Lineouts
        • curve_item_factory()
      • 8.6.6.4.4. pymodaq_gui.plotting.utils.plot_utils module
        • Data0DWithHistory
        • DetachablePanel
        • DockLayoutMenu
        • Point
        • QVector
        • Vector
        • ViewBox
        • display_in_dock()
        • get_dock_layout_menu()
        • get_sub_segmented_n_positions()
        • get_sub_segmented_positions()
        • makeAlphaTriangles()
        • makePolygons()
        • make_dashed_pens()
    • 8.6.6.5. pymodaq_gui.plotting.image_viewer module
      • Image_Viewer
        • Image_Viewer.fitInView()
        • Image_Viewer.setPhoto()
        • Image_Viewer.wheelEvent()
        • Image_Viewer.zoomFactor()
        • Image_Viewer.staticMetaObject
      • Window
        • Window.handleOpen()
        • Window.staticMetaObject
    • 8.6.6.6. 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.log_signal
        • Navigator.params
        • Navigator.settings_name
        • Navigator.sig_double_clicked
        • Navigator.staticMetaObject
    • 8.6.6.7. pymodaq_gui.plotting.widgets module
      • ImageWidget
        • ImageWidget.add_scaled_axis()
        • ImageWidget.getAxis()
        • ImageWidget.setAspectLocked()
        • ImageWidget.setupUI()
        • ImageWidget.staticMetaObject
      • PlotWidget
        • PlotWidget.legend
        • PlotWidget.staticMetaObject
        • PlotWidget.view
  • 8.6.7. pymodaq_gui.resources package
    • 8.6.7.1. pymodaq_gui.resources.material_icons package
  • 8.6.8. pymodaq_gui.utils package
    • 8.6.8.1. pymodaq_gui.utils.widget_sync package
      • 8.6.8.1.1. pymodaq_gui.utils.widget_sync.core module
        • BaseWidgetSync
        • DataType
        • DictSync
        • SyncMode
        • ValueSync
      • 8.6.8.1.2. pymodaq_gui.utils.widget_sync.factories module
        • WidgetSyncFactories
      • 8.6.8.1.3. Qt Widget Synchronization
      • BaseWidgetSync
        • BaseWidgetSync.bind()
        • BaseWidgetSync.check_connection_mode()
        • BaseWidgetSync.disable()
        • BaseWidgetSync.enable()
        • BaseWidgetSync.is_enabled()
        • BaseWidgetSync.set_value()
        • BaseWidgetSync.unbind()
        • BaseWidgetSync.unbind_all()
        • BaseWidgetSync.validate_property_connection()
        • BaseWidgetSync.connected_widgets
        • BaseWidgetSync.connection_count
        • BaseWidgetSync.data_type
        • BaseWidgetSync.staticMetaObject
        • BaseWidgetSync.value
        • BaseWidgetSync.value_changed
      • DataType
        • DataType.BOOL
        • DataType.FLOAT
        • DataType.INT
        • DataType.OBJECT
        • DataType.STR
      • DictSync
        • DictSync.append_to_list()
        • DictSync.bind_dict()
        • DictSync.bind_parameter()
        • DictSync.bind_properties()
        • DictSync.pop_from_list()
        • DictSync.remove_from_list()
        • DictSync.set_value()
        • DictSync.update_key()
        • DictSync.staticMetaObject
        • DictSync.value
      • SyncMode
        • SyncMode.BIDIRECTIONAL
        • SyncMode.FROM_SYNC
        • SyncMode.TO_SYNC
      • ValueSync
        • ValueSync.add()
        • ValueSync.set_value()
        • ValueSync.staticMetaObject
        • ValueSync.value
      • WidgetSync
      • WidgetSyncFactories
        • WidgetSyncFactories.for_checkbox()
        • WidgetSyncFactories.for_combobox()
        • WidgetSyncFactories.for_lineedit()
        • WidgetSyncFactories.for_property()
        • WidgetSyncFactories.for_slider()
        • WidgetSyncFactories.for_spinbox()
    • 8.6.8.2. pymodaq_gui.utils.widgets package
      • 8.6.8.2.1. pymodaq_gui.utils.widgets.collapsible_widget module
        • CollapsibleWidget
      • 8.6.8.2.2. pymodaq_gui.utils.widgets.combo module
        • ComboBox
      • 8.6.8.2.3. pymodaq_gui.utils.widgets.highlighted_combo module
        • ComboModel
        • HighlightedComboBox
      • 8.6.8.2.4. pymodaq_gui.utils.widgets.label module
        • LabelWithFont
      • 8.6.8.2.5. pymodaq_gui.utils.widgets.lcd module
        • LCD
      • 8.6.8.2.6. pymodaq_gui.utils.widgets.multistate_led module
        • LedState
        • MultistateLED
        • main()
      • 8.6.8.2.7. pymodaq_gui.utils.widgets.painter_utils module
        • desaturate()
        • draw_shape()
        • make_brush()
      • 8.6.8.2.8. pymodaq_gui.utils.widgets.pattern_completer module
        • PatternCompleter
        • PatternCompleterDelegate
        • PatternLineEdit
        • PatternPlainTextEdit
        • PatternTextEdit
      • 8.6.8.2.9. pymodaq_gui.utils.widgets.push module
        • ActionMenu
        • EditPush
        • EditPushInfo
        • EditPushRel
        • PushButtonIcon
        • ToolButtonIcon
        • main()
      • 8.6.8.2.10. pymodaq_gui.utils.widgets.qled module
        • QLED
      • 8.6.8.2.11. pymodaq_gui.utils.widgets.search_lineedit module
        • DemoWindow
        • SearchLineEdit
      • 8.6.8.2.12. pymodaq_gui.utils.widgets.spinbox module
        • QSpinBoxWithShortcut
        • QSpinBox_ro
        • SpinBox
      • 8.6.8.2.13. pymodaq_gui.utils.widgets.statusbar_separator module
        • StatuBarSeparator
      • 8.6.8.2.14. pymodaq_gui.utils.widgets.table module
        • BooleanDelegate
        • MyStyle
        • SpinBoxDelegate
        • TableModel
        • TableView
      • 8.6.8.2.15. pymodaq_gui.utils.widgets.tree_layout module
        • CustomTree
        • TreeLayout
      • 8.6.8.2.16. pymodaq_gui.utils.widgets.tree_toml module
        • TreeFromToml
      • 8.6.8.2.17. pymodaq_gui.utils.widgets.widget_bkg module
        • WidgetWithBkg
      • 8.6.8.2.18. pymodaq_gui.utils.widgets.widget_with_label_title module
        • WidgetWithLabelTitle
      • 8.6.8.2.19. pymodaq_gui.utils.widgets.widget_with_title_in_toolbar module
        • WidgetWithTitleInToolbar
      • 8.6.8.2.20. pymodaq_gui.utils.widgets.window module
        • make_window()
    • 8.6.8.3. pymodaq_gui.utils.app_worker module
      • ExtensionWorker
        • ExtensionWorker.pause()
        • ExtensionWorker.start()
        • ExtensionWorker.stop()
        • ExtensionWorker.terminate_workers()
        • ExtensionWorker.update_worker_ntask()
        • ExtensionWorker.h5_manager
        • ExtensionWorker.has_data_processor
        • ExtensionWorker.is_running
        • ExtensionWorker.module_and_data_saver
        • ExtensionWorker.modules_manager
        • ExtensionWorker.n_tasks
        • ExtensionWorker.processor_worker
        • ExtensionWorker.saver_worker
        • ExtensionWorker.settings
        • ExtensionWorker.staticMetaObject
        • ExtensionWorker.workers_terminated
      • ProcessorWorker
        • ProcessorWorker.do_process_data()
        • ProcessorWorker.name
        • ProcessorWorker.params
        • ProcessorWorker.staticMetaObject
        • ProcessorWorker.worker_setting_name
      • SaverWorker
        • SaverWorker.add_nav_axes()
        • SaverWorker.save_data()
        • SaverWorker.name
        • SaverWorker.nav_axes_signal
        • SaverWorker.params
        • SaverWorker.saver
        • SaverWorker.staticMetaObject
        • SaverWorker.worker_setting_name
    • 8.6.8.4. pymodaq_gui.utils.custom_app module
      • CustomApp
        • CustomApp.get_local_folder()
        • CustomApp.get_theme()
        • CustomApp.apply_size_hint()
        • CustomApp.connect_things()
        • CustomApp.do_things_after_ui_setup()
        • CustomApp.enable_workflow_actions()
        • CustomApp.get_help_markdown()
        • CustomApp.insert_custom_status_widgets()
        • CustomApp.populate_status_bar()
        • CustomApp.quit_fun()
        • CustomApp.set_permanent_status()
        • CustomApp.setup_actions()
        • CustomApp.setup_docks()
        • CustomApp.setup_docks_and_widgets()
        • CustomApp.setup_menu()
        • CustomApp.setup_menus_and_toolbars()
        • CustomApp.setup_ui()
        • CustomApp.setup_workflow_actions()
        • CustomApp.update_status()
        • CustomApp.dockarea
        • CustomApp.docks
        • CustomApp.h5_base_group_name
        • CustomApp.h5_manager
        • CustomApp.h5saver
        • CustomApp.log_signal
        • CustomApp.mainwindow
        • CustomApp.menubar
        • CustomApp.module_and_data_saver
        • CustomApp.params
        • CustomApp.show_h5file_statusbar_widgets
        • CustomApp.show_workflow_actions
        • CustomApp.splash_sc
        • CustomApp.staticMetaObject
        • CustomApp.statusbar
        • CustomApp.thread_manager
        • CustomApp.title
      • WorkFlowActions
        • WorkFlowActions.LOG
        • WorkFlowActions.PAUSE
        • WorkFlowActions.START
        • WorkFlowActions.STOP
    • 8.6.8.5. pymodaq_gui.utils.dock module
      • Dock
        • Dock.removeWidget()
        • Dock.removeWidgets()
        • Dock.setOrientation()
        • Dock.dock_focused
        • Dock.grid_layout
        • Dock.staticMetaObject
      • DockArea
        • DockArea.addTempArea()
        • DockArea.moveDock()
        • DockArea.dock_signal
        • DockArea.staticMetaObject
    • 8.6.8.6. pymodaq_gui.utils.enums module
      • MenuToolbarNames
        • MenuToolbarNames.FILE
        • MenuToolbarNames.HELP
        • MenuToolbarNames.RUNTIME
        • MenuToolbarNames.SETTINGS
        • MenuToolbarNames.TOOLBARS
        • MenuToolbarNames.TOOLS
        • MenuToolbarNames.VIEW
    • 8.6.8.7. pymodaq_gui.utils.file_io module
      • select_file()
      • select_file_filter()
    • 8.6.8.8. pymodaq_gui.utils.layout module
      • load_layout_state()
      • save_layout_state()
    • 8.6.8.9. pymodaq_gui.utils.list_picker module
      • ListPicker
        • ListPicker.pick_dialog()
        • ListPicker.staticMetaObject
    • 8.6.8.10. pymodaq_gui.utils.menu_utils module
      • IterableMenu
        • IterableMenu.staticMetaObject
      • MenuButton
        • MenuButton.update_entries()
        • MenuButton.staticMetaObject
        • MenuButton.triggered
      • StickyMenu
        • StickyMenu.mouseReleaseEvent()
        • StickyMenu.staticMetaObject
      • build_menu_from_iterable()
    • 8.6.8.11. pymodaq_gui.utils.shared_ui module
      • PymodaqUpdateTableWidget
        • PymodaqUpdateTableWidget.append_row()
        • PymodaqUpdateTableWidget.setHorizontalHeaderLabels()
        • PymodaqUpdateTableWidget.sizeHint()
        • PymodaqUpdateTableWidget.staticMetaObject
      • SharedUI
        • SharedUI.affect_application()
        • SharedUI.check_update()
        • SharedUI.connect_things()
        • SharedUI.hide()
        • SharedUI.quit_fun()
        • SharedUI.restart_fun()
        • SharedUI.setup_actions()
        • SharedUI.setup_docks_and_widgets()
        • SharedUI.setup_menus_and_toolbars()
        • SharedUI.show()
        • SharedUI.show_about()
        • SharedUI.show_app_help()
        • SharedUI.show_changelog()
        • SharedUI.show_config()
        • SharedUI.show_help()
        • SharedUI.show_log()
        • SharedUI.staticMetaObject
      • main()
    • 8.6.8.12. pymodaq_gui.utils.splash module
      • MySplash
        • MySplash.showMessage()
        • MySplash.staticMetaObject
      • get_pymodaq_pixmap()
      • get_splash_sc()
    • 8.6.8.13. pymodaq_gui.utils.status_palette module
      • 8.6.8.13.1. PyMoDAQ Status Color Palette
        • 8.6.8.13.1.1. Rationale
        • 8.6.8.13.1.2. Color Definitions
        • 8.6.8.13.1.3. Usage with MultistateLED
        • 8.6.8.13.1.4. Usage in a parameter tree
      • Status
        • Status.CRITICAL
        • Status.ERROR
        • Status.IDLE
        • Status.OFF
        • Status.RUNNING
        • Status.WARNING
      • StatusPalette
        • StatusPalette.as_states()
        • StatusPalette.color()
        • StatusPalette.subset()
    • 8.6.8.14. pymodaq_gui.utils.styling module
      • Font
        • Font.apply_to_widget()
        • Font.get_font()
        • Font.color
        • Font.font_name
        • Font.font_size
        • Font.isbold
        • Font.isitalic
      • alpha_color()
      • button_style()
      • color_from_depth()
      • color_to_rgba()
      • create_color()
      • create_font()
      • create_icon()
      • make_shape_icon()
      • menu_style()
      • resource_path_exists()
      • text_color()
      • transform_icon()
    • 8.6.8.15. pymodaq_gui.utils.utils module
      • clickable()
      • create_nested_menu()
      • first_available_integer()
      • h5tree_to_QTree()
      • mkQApp()
      • pngbinary2Qlabel()
      • set_dark_palette()
      • set_enable_recursive()
      • widget_to_png_to_bytes()
  • 8.6.9. pymodaq_gui.config module
    • Config
      • Config.config_name
      • Config.config_template_path
    • get_set_layout_path()
    • get_set_roi_path()
  • 8.6.10. pymodaq_gui.config_saver_loader module
    • ConfigSaverLoader
      • ConfigSaverLoader.load_config()
      • ConfigSaverLoader.save_config()
      • ConfigSaverLoader.base_param
      • ConfigSaverLoader.base_path
  • 8.6.11. pymodaq_gui.messenger module
    • dialog()
    • messagebox()
    • show_message()
  • 8.6.12. pymodaq_gui.qt_utils module
    • WhiteCheckboxStyle
      • WhiteCheckboxStyle.drawPrimitive()
      • WhiteCheckboxStyle.staticMetaObject
    • apply_styling_rules()
    • center_widget_on_screen_and_show()
    • decode_data()
    • mkQApp()
    • setLocale()
    • start_qapplication()
  • 8.6.13. pymodaq_gui.qvariant module
    • QVariant()
  • set_and_check_qt_backend_or_die()
  • set_check_style()
• 8.7. pymodaq_data package
  • 8.7.1. pymodaq_data.h5modules package
    • 8.7.1.1. pymodaq_data.h5modules.exporters package
      • 8.7.1.1.1. pymodaq_data.h5modules.exporters.base module
        • H5h5Exporter
        • H5npyExporter
        • H5txtExporter
      • 8.7.1.1.2. pymodaq_data.h5modules.exporters.flimj module
        • H5asciiExporter
      • 8.7.1.1.3. pymodaq_data.h5modules.exporters.hyperspy module
    • 8.7.1.2. pymodaq_data.h5modules.backends module
      • InvalidDataDimension
      • InvalidDataType
      • InvalidExport
      • InvalidGroupDataType
      • InvalidGroupType
      • InvalidSave
      • InvalidScanType
      • NodeError
      • Attributes
        • Attributes.get()
        • Attributes.to_dict()
        • Attributes.attrs_name
        • Attributes.node
      • CARRAY
        • CARRAY.read()
        • CARRAY.array
      • EARRAY
        • EARRAY.append()
        • EARRAY.append_backend()
      • GROUP
        • GROUP.children()
        • GROUP.children_name()
        • GROUP.get_child()
        • GROUP.remove_children()
      • GroupType
        • GroupType.actuator
        • GroupType.ch
        • GroupType.data
        • GroupType.data_dim
        • GroupType.data_logger
        • GroupType.detector
        • GroupType.external_h5
        • GroupType.scan
      • H5Backend
        • H5Backend.add_group()
        • H5Backend.close_file()
        • H5Backend.create_carray()
        • H5Backend.create_earray()
        • H5Backend.create_vlarray()
        • H5Backend.define_compression()
        • H5Backend.enable_swmr()
        • H5Backend.finalize_swmr()
        • H5Backend.flush()
        • H5Backend.get_attr()
        • H5Backend.get_children()
        • H5Backend.get_group_by_title()
        • H5Backend.get_node()
        • H5Backend.get_node_name()
        • H5Backend.get_node_path()
        • H5Backend.get_parent_node()
        • H5Backend.get_set_group()
        • H5Backend.has_attr()
        • H5Backend.is_node_in_group()
        • H5Backend.isopen()
        • H5Backend.open_file()
        • H5Backend.read()
        • H5Backend.reconcile_swmr_attrs()
        • H5Backend.root()
        • H5Backend.save_file_as()
        • H5Backend.set_attr()
        • H5Backend.set_backend()
        • H5Backend.walk_groups()
        • H5Backend.walk_nodes()
        • H5Backend.filename
        • H5Backend.h5file
        • H5Backend.is_swmr_active
        • H5Backend.is_swmr_capable
        • H5Backend.is_swmr_compatible
        • H5Backend.swmr_mode
      • Node
        • Node.get_attr()
        • Node.set_attr()
        • Node.to_h5_backend()
        • Node.attrs
        • Node.h5file
        • Node.name
        • Node.node
        • Node.parent_node
        • Node.path
        • Node.title
      • SaveType
        • SaveType.actuator
        • SaveType.custom
        • SaveType.detector
        • SaveType.logger
        • SaveType.optimizer
        • SaveType.scan
      • StringARRAY
        • StringARRAY.append()
        • StringARRAY.array_to_string()
        • StringARRAY.read()
        • StringARRAY.string_to_array()
      • VLARRAY
        • VLARRAY.append()
        • VLARRAY.append_backend()
      • check_mandatory_attrs()
      • get_attr()
      • set_attr()
    • 8.7.1.3. pymodaq_data.h5modules.browsing module
      • H5BrowserUtil
        • H5BrowserUtil.export_data()
        • H5BrowserUtil.get_h5_attributes()
        • H5BrowserUtil.get_h5file_scans()
    • 8.7.1.4. pymodaq_data.h5modules.data_saving module
      • AxisError
      • AxisSaverLoader
        • AxisSaverLoader.add_axis()
        • AxisSaverLoader.get_axes()
        • AxisSaverLoader.load_axis()
        • AxisSaverLoader.data_type
      • BkgSaver
        • BkgSaver.data_type
      • DataBundle
        • DataBundle.axis_values
        • DataBundle.distribution
        • DataBundle.dte
        • DataBundle.indexes
        • DataBundle.node
        • DataBundle.save_index
        • DataBundle.settings
      • DataEnlargeableSaver
        • DataEnlargeableSaver.add_data()
        • DataEnlargeableSaver.data_type
      • DataExtendedSaver
        • DataExtendedSaver.add_data()
        • DataExtendedSaver.data_type
      • DataLoader
        • DataLoader.close_file()
        • DataLoader.get_nav_group()
        • DataLoader.get_node()
        • DataLoader.load_all()
        • DataLoader.load_data()
        • DataLoader.load_data_from_name_origin()
        • DataLoader.walk_nodes()
        • DataLoader.h5saver
        • DataLoader.raw_group
      • DataManagement
        • DataManagement.close()
        • DataManagement.close_file()
        • DataManagement.get_index_from_node_name()
        • DataManagement.get_last_node_name()
        • DataManagement.get_node_from_index()
        • DataManagement.data_type
        • DataManagement.raw_group
      • DataSaverLoader
        • DataSaverLoader.add_data()
        • DataSaverLoader.get_axes()
        • DataSaverLoader.get_bkg_nodes()
        • DataSaverLoader.get_data_arrays()
        • DataSaverLoader.isopen()
        • DataSaverLoader.load_data()
        • DataSaverLoader.data_type
      • DataToExportEnlargeableSaver
        • DataToExportEnlargeableSaver.add_data()
        • DataToExportEnlargeableSaver.add_data_bundle()
      • DataToExportExtendedSaver
        • DataToExportExtendedSaver.add_data()
        • DataToExportExtendedSaver.add_data_bundle()
        • DataToExportExtendedSaver.add_nav_axes()
      • DataToExportSaver
        • DataToExportSaver.channel_formatter()
        • DataToExportSaver.add_bkg()
        • DataToExportSaver.add_data()
        • DataToExportSaver.add_data_bundle()
        • DataToExportSaver.add_error()
        • DataToExportSaver.close()
        • DataToExportSaver.close_file()
        • DataToExportSaver.isopen()
        • DataToExportSaver.h5saver
      • DataToExportTimedSaver
        • DataToExportTimedSaver.add_data()
        • DataToExportTimedSaver.add_data_bundle()
      • ErrorSaverLoader
        • ErrorSaverLoader.data_type
    • 8.7.1.5. pymodaq_data.h5modules.exporter module
      • ExporterFactory
        • ExporterFactory.create_exporter()
        • ExporterFactory.get_file_filters()
        • ExporterFactory.register_exporter()
        • ExporterFactory.get_format_from_filter()
        • ExporterFactory.exporters_registry
        • ExporterFactory.file_filters
    • 8.7.1.6. pymodaq_data.h5modules.saving module
      • DataType
        • DataType.axis
        • DataType.bkg
        • DataType.data
        • DataType.data_enlargeable
        • DataType.error
        • DataType.external_h5
        • DataType.live_scan
        • DataType.strings
      • FileType
        • FileType.actuator
        • FileType.axis
        • FileType.detector
        • FileType.scan
      • H5SaverLowLevel
        • H5SaverLowLevel.from_file()
        • H5SaverLowLevel.add_act_group()
        • H5SaverLowLevel.add_array()
        • H5SaverLowLevel.add_ch_group()
        • H5SaverLowLevel.add_data_group()
        • H5SaverLowLevel.add_det_group()
        • H5SaverLowLevel.add_generic_group()
        • H5SaverLowLevel.add_incremental_group()
        • H5SaverLowLevel.add_log()
        • H5SaverLowLevel.add_move_group()
        • H5SaverLowLevel.add_scan_group()
        • H5SaverLowLevel.add_string_array()
        • H5SaverLowLevel.get_groups()
        • H5SaverLowLevel.get_last_group()
        • H5SaverLowLevel.get_node_from_attribute_match()
        • H5SaverLowLevel.get_node_from_title()
        • H5SaverLowLevel.get_set_group()
        • H5SaverLowLevel.get_set_logger()
        • H5SaverLowLevel.init_file()
        • H5SaverLowLevel.save_file()
        • H5SaverLowLevel.set_swmr_flush_interval()
        • H5SaverLowLevel.tick_flush()
        • H5SaverLowLevel.fill_value
        • H5SaverLowLevel.h5_file
        • H5SaverLowLevel.raw_group
    • 8.7.1.7. pymodaq_data.h5modules.swmr module
      • 8.7.1.7.1. Typical usage
      • collect_datasets()
      • refresh_cached()
      • refresh_datasets()
    • 8.7.1.8. pymodaq_data.h5modules.utils module
      • extract_axis()
      • find_scan_node()
      • get_h5_attributes()
      • get_h5_data_from_node()
      • register_exporter()
      • register_exporters()
      • verify_axis_data_uniformity()
    • is_file_swmr_active()
    • open_h5_file_for_reading()
  • 8.7.2. pymodaq_data.plotting package
    • 8.7.2.1. pymodaq_data.plotting.utils module
      • PlotColors
        • PlotColors.check_color()
        • PlotColors.check_colors()
        • PlotColors.copy()
        • PlotColors.remove()
  • 8.7.3. pymodaq_data.post_treatment package
    • 8.7.3.1. pymodaq_data.post_treatment.process_to_scalar module
      • ArgMaxProcessor
        • ArgMaxProcessor.operate()
        • ArgMaxProcessor.apply_to
      • ArgMeanProcessor
        • ArgMeanProcessor.operate()
        • ArgMeanProcessor.apply_to
      • ArgMinProcessor
        • ArgMinProcessor.operate()
        • ArgMinProcessor.apply_to
      • ArgStdProcessor
        • ArgStdProcessor.operate()
        • ArgStdProcessor.apply_to
      • DataProcessorBase
        • DataProcessorBase.apply_to
        • DataProcessorBase.flatten_signal_dim()
        • DataProcessorBase.operate()
        • DataProcessorBase.process()
      • DataProcessorFactory
        • DataProcessorFactory.functions_filtered()
        • DataProcessorFactory.get()
        • DataProcessorFactory.functions
      • MaxProcessor
        • MaxProcessor.operate()
        • MaxProcessor.apply_to
      • MeanProcessor
        • MeanProcessor.operate()
        • MeanProcessor.apply_to
      • MinProcessor
        • MinProcessor.operate()
        • MinProcessor.apply_to
      • StdProcessor
        • StdProcessor.operate()
        • StdProcessor.apply_to
      • SumProcessor
        • SumProcessor.operate()
        • SumProcessor.apply_to
  • 8.7.4. pymodaq_data.resources package
  • 8.7.5. pymodaq_data.config module
    • Config
      • Config.config_name
      • Config.config_template_path
  • 8.7.6. pymodaq_data.data module
    • DataDimError
    • DataDimWarning
    • DataIndexWarning
    • DataLengthError
    • DataShapeError
    • DataSizeWarning
    • DataTypeWarning
    • DataUnitError
    • warning
    • Averaging
      • Averaging.AVERAGED
      • Averaging.N_AVERAGED
    • AxesManagerBase
      • AxesManagerBase.append_axis()
      • AxesManagerBase.compute_shape_from_axes()
      • AxesManagerBase.compute_sig_indexes()
      • AxesManagerBase.get_axes_index()
      • AxesManagerBase.get_axis_from_index()
      • AxesManagerBase.get_axis_from_index_spread()
      • AxesManagerBase.get_nav_axes()
      • AxesManagerBase.get_shape_from_index()
      • AxesManagerBase.get_signal_axes()
      • AxesManagerBase.get_sorted_index()
      • AxesManagerBase.is_axis_navigation()
      • AxesManagerBase.is_axis_signal()
      • AxesManagerBase.axes
      • AxesManagerBase.nav_axes
      • AxesManagerBase.nav_indexes
      • AxesManagerBase.nav_shape
      • AxesManagerBase.shape
      • AxesManagerBase.sig_indexes
      • AxesManagerBase.sig_shape
    • AxesManagerSpread
      • AxesManagerSpread.compute_shape_from_axes()
      • AxesManagerSpread.get_axis_from_index()
      • AxesManagerSpread.get_axis_from_index_spread()
      • AxesManagerSpread.get_shape_from_index()
      • AxesManagerSpread.get_sorted_index()
    • AxesManagerUniform
      • AxesManagerUniform.compute_shape_from_axes()
      • AxesManagerUniform.get_axis_from_index()
      • AxesManagerUniform.get_axis_from_index_spread()
      • AxesManagerUniform.get_shape_from_index()
      • AxesManagerUniform.get_sorted_index()
    • Axis
      • Axis.create_simple_linear_data()
      • Axis.deserialize()
      • Axis.from_quantity()
      • Axis.serialize()
      • Axis.as_dwa()
      • Axis.copy()
      • Axis.create_linear_data()
      • Axis.find_index()
      • Axis.find_indexes()
      • Axis.flip()
      • Axis.force_units()
      • Axis.get_data()
      • Axis.get_data_at()
      • Axis.get_quantity()
      • Axis.get_scale_offset_from_data()
      • Axis.is_axis_linear()
      • Axis.max()
      • Axis.mean()
      • Axis.min()
      • Axis.to_base_units()
      • Axis.to_reduced_units()
      • Axis.units_as()
      • Axis.axis_width
      • Axis.base_type
      • Axis.data
      • Axis.iaxis
      • Axis.index
      • Axis.label
      • Axis.offset
      • Axis.scaling
      • Axis.size
      • Axis.units
      • Axis.vaxis
    • DataBase
      • DataBase.get_origin_name_from_full_name()
      • DataBase.abs()
      • DataBase.add_extra_attribute()
      • DataBase.angle()
      • DataBase.append()
      • DataBase.as_dte()
      • DataBase.average()
      • DataBase.check_shape_from_data()
      • DataBase.deepcopy()
      • DataBase.equal_to()
      • 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.split_as_dte()
      • DataBase.stack_as_array()
      • DataBase.to_base_units()
      • DataBase.to_dB()
      • DataBase.to_dict()
      • DataBase.units_as()
      • DataBase.unwrap()
      • DataBase.value()
      • DataBase.values()
      • DataBase.averaged
      • DataBase.base_type
      • DataBase.data
      • DataBase.dim
      • DataBase.distribution
      • DataBase.labels
      • DataBase.length
      • DataBase.n_averaged
      • DataBase.quantities
      • DataBase.shape
      • DataBase.size
      • DataBase.source
      • DataBase.units
    • DataCalculated
    • DataDim
      • DataDim.from_data_array()
      • DataDim.Data0D
      • DataDim.Data1D
      • DataDim.Data2D
      • DataDim.DataND
      • DataDim.dim_index
    • DataDistribution
      • DataDistribution.spread
      • DataDistribution.uniform
    • DataFromRoi
    • DataLowLevel
      • DataLowLevel.name
      • DataLowLevel.timestamp
    • DataRaw
    • DataSource
      • DataSource.calculated
      • DataSource.raw
    • DataToExport
      • DataToExport.deserialize()
      • DataToExport.from_xarray()
      • DataToExport.serialize()
      • DataToExport.add_extra_attribute()
      • DataToExport.affect_name_to_origin_if_none()
      • DataToExport.average()
      • DataToExport.deepcopy()
      • 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_full_names()
      • DataToExport.get_data_from_missing_attribute()
      • DataToExport.get_data_from_name()
      • DataToExport.get_data_from_name_origin()
      • DataToExport.get_data_from_names()
      • DataToExport.get_data_from_origins()
      • DataToExport.get_data_from_sig_axes()
      • DataToExport.get_data_from_source()
      • DataToExport.get_data_with_naxes_lower_than()
      • DataToExport.get_dim_presents()
      • DataToExport.get_full_names()
      • DataToExport.get_names()
      • DataToExport.get_origins()
      • DataToExport.index()
      • DataToExport.index_from_name_origin()
      • DataToExport.merge_as_dwa()
      • DataToExport.plot()
      • DataToExport.pop()
      • DataToExport.remove()
      • DataToExport.to_xarray()
      • DataToExport.append
      • DataToExport.data
    • DataWithAxes
      • DataWithAxes.deserialize()
      • DataWithAxes.from_xarray()
      • DataWithAxes.serialize()
      • DataWithAxes.axes_limits()
      • DataWithAxes.check_axes_linear()
      • DataWithAxes.check_squeeze()
      • DataWithAxes.create_missing_axes()
      • DataWithAxes.crop_at_along()
      • DataWithAxes.deepcopy_with_new_data()
      • DataWithAxes.errors_as_dwa()
      • DataWithAxes.find_peaks()
      • DataWithAxes.fit()
      • DataWithAxes.ft()
      • DataWithAxes.get_axes_sizes()
      • DataWithAxes.get_axis_from_index()
      • DataWithAxes.get_axis_from_index_spread()
      • DataWithAxes.get_axis_from_label()
      • DataWithAxes.get_axis_indexes()
      • DataWithAxes.get_data_as_dwa()
      • DataWithAxes.get_data_dimension()
      • DataWithAxes.get_dim_from_data_axes()
      • DataWithAxes.get_error()
      • DataWithAxes.get_nav_axes()
      • DataWithAxes.get_nav_axes_with_data()
      • DataWithAxes.get_sig_index()
      • DataWithAxes.ift()
      • DataWithAxes.interp()
      • DataWithAxes.mean()
      • DataWithAxes.moment()
      • DataWithAxes.pad()
      • DataWithAxes.plot()
      • DataWithAxes.rot90()
      • DataWithAxes.set_axes_manager()
      • DataWithAxes.sort_data()
      • DataWithAxes.sum()
      • DataWithAxes.to_xarray()
      • DataWithAxes.transpose()
      • DataWithAxes.axes
      • DataWithAxes.errors
      • DataWithAxes.n_axes
      • DataWithAxes.nav_indexes
      • DataWithAxes.sig_indexes
    • DwaType
      • DwaType.DataActuator
      • DwaType.DataCalculated
      • DwaType.DataFromPlugins
      • DwaType.DataRaw
      • DwaType.DataWithAxes
    • NavAxis
      • NavAxis.iaxis
      • NavAxis.vaxis
    • check_units()
    • dimensionless_aware_reduce_units()
    • parse_quantity()
    • squeeze()
  • 8.7.7. pymodaq_data.numpy_func module
    • implements()
    • process_arguments_for_ufuncs()
    • process_with_reduced_dimensions()
  • 8.7.8. pymodaq_data.slicing module
    • SpecialSlicers
    • SpecialSlicersData
• 8.8. Modules Path changes from v4 to v5