iaa_od.visualisation.show_utils

Functions

build_save_path(filepath, extension)	Utility function that constructs a save path for an image with a timestamp, ensuring the filepath ends with a forward slash.
get_image_path(filename, filepath)	Utility function that simply constructs the entire path for a given image filename.
upsert_handle(handles, new_handle)	Utility function that adds a new legend handle to the list of handles if it does not already exist.
validate_filepath(filepath)	Utility function that validates the provided filepath.

iaa_od.visualisation.show_utils.build_save_path(filepath, extension)

Utility function that constructs a save path for an image with a timestamp, ensuring the filepath ends with a forward slash.

Parameters:

• filepath (str) – The base filepath where the image will be saved.

• extension (str) – The file extension for the saved image (e.g., ‘.png’, ‘.jpg’).

Returns:

The constructed save path for the image.

Return type:

str

iaa_od.visualisation.show_utils.get_image_path(filename, filepath)

Utility function that simply constructs the entire path for a given image filename. If necessary, the function also adds the ending forwards slash to the filepath.

Parameters:

• filename (str) – The image filename.

• filepath (str) – The filepath where the image is located.

Returns:

The full path to the image.

Return type:

str

iaa_od.visualisation.show_utils.upsert_handle(handles, new_handle)

Utility function that adds a new legend handle to the list of handles if it does not already exist.

Parameters:

• handles (list[Patch]) – The list of existing legend handles.

• new_handle (Patch) – The new legend handle to add.

Return type:

None

iaa_od.visualisation.show_utils.validate_filepath(filepath)

Utility function that validates the provided filepath.

Parameters:

filepath (str) – The filepath to validate.

Returns:

The validated filepath, ensuring it ends with a forward slash.

Return type:

str