xrf_explorer.server.file_system package

Subpackages

• xrf_explorer.server.file_system.cubes package
  • Submodules
  • xrf_explorer.server.file_system.cubes.convert_csv module
    • get_elemental_data_cube_from_csv()
    • get_elemental_map_from_csv()
    • get_elements_from_csv()
  • xrf_explorer.server.file_system.cubes.convert_dms module
    • get_elemental_data_cube_from_dms()
    • get_elemental_datacube_dimensions()
    • get_elemental_map_from_dms()
    • get_elements_from_dms()
    • to_dms()
  • xrf_explorer.server.file_system.cubes.elemental module
    • convert_elemental_cube_to_dms()
    • get_element_averages()
    • get_element_averages_selection()
    • get_element_names()
    • get_elemental_data_cube()
    • get_elemental_map()
    • get_short_element_names()
    • normalize_elemental_cube_per_layer()
    • normalize_ndarray_to_grayscale()
  • xrf_explorer.server.file_system.cubes.spectral module
    • bin_data()
    • get_raw_data()
    • get_spectra_params()
    • mipmap_exists()
    • mipmap_raw_cube()
    • parse_rpl()
    • update_bin_params()
  • Module contents
• xrf_explorer.server.file_system.sources package
  • Submodules
  • xrf_explorer.server.file_system.sources.data_listing module
    • get_data_source_files()
    • get_data_sources_names()
  • Module contents
• xrf_explorer.server.file_system.workspace package
  • Submodules
  • xrf_explorer.server.file_system.workspace.contextual_images module
    • get_base_image_name()
    • get_contextual_image()
    • get_contextual_image_data()
    • get_contextual_image_path()
    • get_contextual_image_recipe_path()
    • get_contextual_image_size()
    • get_path_to_base_image()
    • is_base_image()
  • xrf_explorer.server.file_system.workspace.file_access module
    • get_base_image_name()
    • get_base_image_path()
    • get_elemental_cube_file_names()
    • get_elemental_cube_path()
    • get_elemental_cube_path_from_name()
    • get_elemental_cube_recipe_path()
    • get_raw_rpl_names()
    • get_raw_rpl_paths()
    • get_spectral_cube_recipe_path()
    • get_workspace_dict()
    • set_binned()
  • xrf_explorer.server.file_system.workspace.workspace_handler module
    • get_path_to_workspace()
    • update_workspace()
  • Module contents

Submodules

xrf_explorer.server.file_system.helper module

data_source_name_from_cube_path(path_to_cube: str) → str

Gets the name of the data source from the path to the cube.

Parameters:

path_to_cube – The path to the cube

Returns:

The name of the data source where the cube is located

get_config() → dict | None

Gets the set configuration for the backend. :return: A dictionary containing the configuration for the backend.

get_path_to_generated_folder(data_source: str) → str

Gets the path to the generated folder for a given data source. If it does not exist, it will be created.

Parameters:

data_source – The data source for which the path is requested.

Returns:

The path to the generated folder for the given data source. Empty string is returned in case of error.

set_config(path: str) → bool

Sets the global configuration for the backend. :param path: The path to the configuration file. :return: True if the configuration file was successfully loaded.

Module contents

This module handles everything related to routing, storing, or extracting files in the backend of the application.