3. API reference

3.1. Rendering

• 3.1.1. broh5.lib.rendering
  • GuiRendering
    • GuiRendering.fig_size
    • GuiRendering.plot_size
    • GuiRendering.tree_container
    • GuiRendering.select_file_button
    • GuiRendering.file_path_display
    • GuiRendering.hdf_key_display
    • GuiRendering.hdf_value_display
    • GuiRendering.axis_list
    • GuiRendering.cmap_list
    • GuiRendering.enable_zoom
    • GuiRendering.zoom_list
    • GuiRendering.enable_profile
    • GuiRendering.profile_list
    • GuiRendering.save_image_button
    • GuiRendering.display_type
    • GuiRendering.marker_list
    • GuiRendering.save_data_button
    • GuiRendering.main_slider
    • GuiRendering.main_table
    • GuiRendering.main_plot
    • GuiRendering.zoom_profile_plot
    • GuiRendering.min_slider
    • GuiRendering.max_slider
    • GuiRendering.reset_button
    • GuiRendering.histogram_plot
    • GuiRendering.image_info_table
    • GuiRendering.init_gui()
  • FilePicker
    • FilePicker.check_extension()
    • FilePicker.add_drives_toggle()
    • FilePicker.update_grid()
    • FilePicker.handle_double_click()
    • FilePicker.handle_ok()
  • FileSaver
    • FileSaver.add_drives_toggle()
    • FileSaver.update_grid()
    • FileSaver.handle_double_click()
    • FileSaver.handle_save()
    • FileSaver.create_folder_dialog()
    • FileSaver.create_folder()

3.2. Utilities

• 3.2.1. broh5.lib.utilities
  • get_height_width_screen()
  • hdf_tree_to_dict()
  • get_hdf_data()
  • check_external_link()
  • check_compressed_dataset()
  • format_table_from_array()
  • format_statistical_info()
  • save_image()
  • save_table()
  • get_config_path()
  • save_config()
  • load_config()
  • get_image_roi()

3.3. Interactions

• 3.3.1. broh5.lib.interactions
  • GuiInteraction
    • GuiInteraction.current_state
    • GuiInteraction.columns
    • GuiInteraction.rows
    • GuiInteraction.image
    • GuiInteraction.current_slice
    • GuiInteraction.data_1d_2d
    • GuiInteraction.timer
    • GuiInteraction.mouse_handler()
    • GuiInteraction.show_key()
    • GuiInteraction.pick_file()
    • GuiInteraction.display_hdf_tree()
    • GuiInteraction.disable_sliders()
    • GuiInteraction.enable_ui_elements_3d_data()
    • GuiInteraction.enable_ui_elements_1d_2d_data()
    • GuiInteraction.reset()
    • GuiInteraction.reset_min_max()
    • GuiInteraction.display_3d_data()
    • GuiInteraction.display_1d_2d_data()
    • GuiInteraction.show_data()
    • GuiInteraction.save_image()
    • GuiInteraction.save_data()
    • GuiInteraction.shutdown()
    • GuiInteraction.mouse_handler()