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()