ewoksfluo.io.output_uri.compose_full_output_uri#

ewoksfluo.io.output_uri.compose_full_output_uri(output_root_uri, default_output_data_path=None, extra_data_paths=None)[source]#

Compose a full HDF5 URI by combining a root URI with optional data path default and extra data paths.

The function returns a URI in the form file_path::/data/path, merging: 1. The base file path from output_root_uri. 2. Default data path segments if the root path is shorter than expected. 3. Optional additional path segments from extra_data_paths.

Parameters:
  • output_root_uri (str) – The root HDF5 URI, e.g., “file.h5::/1.1/detector_name/fit”.

  • default_output_data_path (Optional[str]) – Optional default HDF5 data path to fill in missing segments.

  • extra_end_path – Optional extra path components to append to the final data path.

Return type:

str

Returns:

The composed HDF5 URI with file path and full data path.

Example:

uri = compose_full_output_uri(
    "results.h5::/1.1",
    default_output_data_path="results/detector_name",
    extra_data_paths=("fit",),
)
# Result: "results.h5::/1.1/detector_name/fit"
Parameters:

extra_data_paths (Optional[Sequence[str]])