8.4. Utility Libraries

• 8.4.1. Utility Classes
  • ThreadCommand
    • ThreadCommand.command
    • ThreadCommand.attribute
• 8.4.2. TCP/IP related methods
  • 8.4.2.1. Serializing object to bytes and back
    • DeSerializer
      • DeSerializer.axis_deserialization()
      • DeSerializer.boolean_deserialization()
      • DeSerializer.bytes_to_int()
      • DeSerializer.bytes_to_nd_array()
      • DeSerializer.bytes_to_scalar()
      • DeSerializer.dte_deserialization()
      • DeSerializer.dwa_deserialization()
      • DeSerializer.list_deserialization()
      • DeSerializer.ndarray_deserialization()
      • DeSerializer.scalar_deserialization()
      • DeSerializer.string_deserialization()
    • Serializer
      • Serializer.axis_serialization()
      • Serializer.dte_serialization()
      • Serializer.dwa_serialization()
      • Serializer.int_to_bytes()
      • Serializer.list_serialization()
      • Serializer.ndarray_serialization()
      • Serializer.object_type_serialization()
      • Serializer.scalar_serialization()
      • Serializer.str_len_to_bytes()
      • Serializer.string_serialization()
      • Serializer.to_bytes()
    • SocketString
      • SocketString.check_received_length()
      • SocketString.get_first_nbytes()
  • 8.4.2.2. Custom Sockets to implement PyMoDAQ protocol
    • Socket
      • Socket.check_received_length()
      • Socket.check_sended()
      • Socket.check_sended_with_serializer()
      • Socket.get_first_nbytes()
  • 8.4.2.3. Base classes as TCP server and client
    • Grabber
      • Grabber.grab_data()
    • MockServer
    • TCPClient
      • TCPClient.get_data()
      • TCPClient.post_init()
      • TCPClient.queue_command()
      • TCPClient.ready_to_read()
      • TCPClient.ready_to_write()
      • TCPClient.ready_with_error()
    • TCPServer
      • TCPServer.close_server()
      • TCPServer.find_socket_type_within_connected_clients()
      • TCPServer.find_socket_within_connected_clients()
      • TCPServer.listen_client()
      • TCPServer.print_status()
      • TCPServer.process_cmds()
      • TCPServer.read_info()
      • TCPServer.select()
      • TCPServer.send_command()
      • TCPServer.set_connected_clients_table()
      • TCPServer.timerEvent()
• 8.4.3. Units conversion
  • Ecmrel2Enm()
  • Enm2cmrel()
  • cm2nm()
  • eV2cm()
  • eV2nm()
  • l2w()
  • nm2cm()
  • nm2eV()
• 8.4.4. Mathematical utilities
  • find_index()
  • ft()
  • ft2()
  • ftAxis()
  • ftAxis_time()
  • gauss1D()
  • gauss2D()
  • ift()
  • ift2()
  • linspace_step()
  • my_moment()
  • odd_even()
• 8.4.5. Scan utilities
• 8.4.6. File management
  • select_file()
• 8.4.7. Data Management
  • 8.4.7.1. Axes
    • Axis
      • Axis.create_linear_data()
      • Axis.find_index()
      • Axis.get_data()
      • Axis.get_data_at()
      • Axis.get_scale_offset_from_data()
      • Axis.data
      • Axis.index
      • Axis.label
      • Axis.size
      • Axis.units
  • 8.4.7.2. DataObjects
    • DataBase
      • DataBase.name
      • DataBase.source
      • DataBase.dim
      • DataBase.distribution
      • DataBase.data
      • DataBase.labels
      • DataBase.origin
      • DataBase.shape
      • DataBase.size
      • DataBase.length
      • DataBase.extra_attributes
      • DataBase.abs()
      • DataBase.as_dte()
      • DataBase.average()
      • DataBase.fliplr()
      • DataBase.flipud()
      • DataBase.get_data_index()
      • DataBase.get_dim_from_data()
      • DataBase.get_full_name()
      • DataBase.imag()
      • DataBase.pop()
      • DataBase.real()
      • DataBase.set_dim()
      • DataBase.stack_as_array()
      • DataBase.data
      • DataBase.dim
      • DataBase.distribution
      • DataBase.length
      • DataBase.shape
      • DataBase.size
      • DataBase.source
    • DataCalculated
    • DataFromPlugins
      • DataFromPlugins.do_plot
      • DataFromPlugins.do_save
    • DataFromRoi
    • DataRaw
  • 8.4.7.3. Data Characteristics
    • DataDim
    • DataDistribution
    • DataSource
  • 8.4.7.4. Union of Data
    • DataToExport
      • DataToExport.name
      • DataToExport.timestamp
      • DataToExport.data
      • DataToExport.affect_name_to_origin_if_none()
      • DataToExport.average()
      • DataToExport.get_data_from_Naxes()
      • DataToExport.get_data_from_attribute()
      • DataToExport.get_data_from_dim()
      • DataToExport.get_data_from_dims()
      • DataToExport.get_data_from_full_name()
      • DataToExport.get_data_from_missing_attribute()
      • DataToExport.get_data_from_name()
      • DataToExport.get_data_from_name_origin()
      • DataToExport.get_data_from_sig_axes()
      • DataToExport.get_data_from_source()
      • DataToExport.get_data_with_naxes_lower_than()
      • DataToExport.get_full_names()
      • DataToExport.get_names()
      • DataToExport.get_origins()
      • DataToExport.index_from_name_origin()
      • DataToExport.merge_as_dwa()
      • DataToExport.plot()
      • DataToExport.pop()
      • DataToExport.data

8.4.8. parameter

Extension of the pyqtgraph Parameter, ParameterTree widgets and dedicated functions to deals with Parameters (e.g. save them in XML)

• 8.4.8.1. New Tree items
• 8.4.8.2. Parameter and XML
  • XML_file_to_parameter()
  • XML_string_to_parameter()
  • add_text_to_elt()
  • dict_from_param()
  • elt_to_dict()
  • parameter_to_xml_file()
  • parameter_to_xml_string()
  • set_txt_from_elt()
  • walk_parameters_to_xml()
  • walk_xml_to_parameter()
• 8.4.8.3. Parameter management
  • get_param_from_name()
  • get_param_path()
  • iter_children()
  • iter_children_params()