API Documentation for figures

class FigureMerger(binding_mode, occurrence_percent, split_data, merged_image_paths)

Handles the creation and merging of binding mode figures with corresponding legends.

Parameters:

  • binding_mode (str) – Name of the binding mode for which figures are created.

  • occurrence_percent (float) – Occurrence percentage of the binding mode.

  • split_data (list) – Interaction descriptors used for generating the figure legend.

  • merged_image_paths (list) – List storing paths to the output merged images.

create_and_merge_images()

Create and merge images to generate a legend for binding modes.

Returns:

Updated list of paths to the merged images.

Return type:

list of str

class FigureArranger(merged_image_paths, output_path)

Arranges multiple merged binding mode figures into a single image.

Parameters:

  • merged_image_paths (list) – List of file paths to pre merged figures.

  • output_path (str) – File path where the final arranged figure should be saved.

arranged_figure_generation()

Generate an arranged figure by arranging merged images in rows and columns.

Returns:

None. This function writes out a figure and does not return anything.

Return type:

None