6.4. Utility Libraries

• 6.4.1. Utility Classes
  • ThreadCommand
    • ThreadCommand.command
    • ThreadCommand.attribute
• 6.4.2. TCP/IP related methods
  • Grabber
    • Grabber.grab_data()
  • MockServer
  • TCPClient
    • TCPClient.get_data()
    • TCPClient.post_init()
    • TCPClient.queue_command()
    • TCPClient.ready_to_read()
    • TCPClient.ready_to_write()
    • TCPClient.ready_with_error()
  • TCPServer
    • TCPServer.close_server()
    • TCPServer.find_socket_type_within_connected_clients()
    • TCPServer.find_socket_within_connected_clients()
    • TCPServer.listen_client()
    • TCPServer.print_status()
    • TCPServer.process_cmds()
    • TCPServer.read_info()
    • TCPServer.select()
    • TCPServer.send_command()
    • TCPServer.set_connected_clients_table()
    • TCPServer.timerEvent()
• 6.4.3. Units conversion
  • Ecmrel2Enm()
  • Enm2cmrel()
  • cm2nm()
  • eV2cm()
  • eV2nm()
  • l2w()
  • nm2cm()
  • nm2eV()
• 6.4.4. Mathematical utilities
  • find_index()
  • ft()
  • ft2()
  • ftAxis()
  • ftAxis_time()
  • gauss1D()
  • gauss2D()
  • ift()
  • ift2()
  • linspace_step()
  • my_moment()
  • odd_even()
• 6.4.5. Scan utilities
• 6.4.6. File management
  • select_file()
• 6.4.7. Data Management
  • DataDimWarning
  • DataIndexWarning
  • DataLengthError
  • DataShapeError
  • DataSizeWarning
  • DataTypeWarning
  • warning
  • AxesManagerSpread
    • AxesManagerSpread.compute_shape_from_axes()
    • AxesManagerSpread.get_axis_from_index()
    • AxesManagerSpread.get_shape_from_index()
  • Axis
    • Axis.create_linear_data()
    • Axis.find_index()
    • Axis.get_data()
    • Axis.get_scale_offset_from_data()
    • Axis.data
    • Axis.index
    • Axis.label
    • Axis.size
    • Axis.units
  • DataBase
    • DataBase.name
    • DataBase.source
    • DataBase.dim
    • DataBase.distribution
    • DataBase.data
    • DataBase.labels
    • DataBase.origin
    • DataBase.shape
    • DataBase.size
    • DataBase.length
    • DataBase.extra_attributes
    • DataBase.average()
    • DataBase.get_data_index()
    • DataBase.get_dim_from_data()
    • DataBase.get_full_name()
    • DataBase.set_dim()
    • DataBase.data
    • DataBase.dim
    • DataBase.distribution
    • DataBase.length
    • DataBase.shape
    • DataBase.size
    • DataBase.source
  • DataCalculated
  • DataDim
  • DataDistribution
  • DataFromPlugins
  • DataFromRoi
  • DataLowLevel
    • DataLowLevel.name
    • DataLowLevel.timestamp
    • DataLowLevel.name
    • DataLowLevel.timestamp
  • DataRaw
  • DataScan
  • DataSource
  • DataToExport
    • DataToExport.name
    • DataToExport.timestamp
    • DataToExport.data
    • DataToExport.affect_name_to_origin_if_none()
    • DataToExport.average()
    • DataToExport.get_data_from_Naxes()
    • DataToExport.get_data_from_dim()
    • DataToExport.get_data_from_dims()
    • DataToExport.get_data_from_full_name()
    • DataToExport.get_data_from_name()
    • DataToExport.get_data_from_name_origin()
    • DataToExport.get_data_from_source()
    • DataToExport.get_full_names()
    • DataToExport.get_names()
    • DataToExport.index_from_name_origin()
    • DataToExport.pop()
    • DataToExport.data
  • DataWithAxes
    • DataWithAxes.create_missing_axes()
    • DataWithAxes.deepcopy_with_new_data()
    • DataWithAxes.get_axis_indexes()
    • DataWithAxes.get_dim_from_data_axes()
    • DataWithAxes.get_nav_axes_with_data()
    • DataWithAxes.mean()
    • DataWithAxes.sort_data()
    • DataWithAxes.transpose()
    • DataWithAxes.axes
    • DataWithAxes.nav_indexes
    • DataWithAxes.sig_indexes
  • NavAxis

6.4.8. parameter

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

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