Function reference • duflor.gui

GUI-Starter function

duflor_gui(): Start the duflor-gui via this function

Main Utility

execute_analysis(): wrapper-function facilitating single- and multi-image analysis.

execute_multiple(): execute analysis on multiple images, and return their results

execute_single(): execute analysis on a single image, and return its results

gui components

open_parallelPanel_event(): internal callback function for the checkbox opening the parallelisation-panel

select_spectra_gui_comp(): generate and call a modal-dialogue which lets you select which spectrums to analyse.

show_infringing_spectrum_elements_gui_comp(): generate and call a modal-dialogue which displays the prospective changes in HSV-spectrums

render_selected_mask(): render mask based on input data

Miscellaneous internals

dev_key_handler(): handles the setting and unsetting of debug-keys

key_handle_cores(): internal function handling dev-key ---set.cores=XX

convert_pixels_to_area_gui(): convert pixel counts to an area based on the known area of an identifier-dot.

get_group(): trims numbers from groups from character-vector

get_image_dimensions(): retrieves image dimension via call to system interface

get_KPI_plot(): generate a ggplot for a given KPI

limit_identifier_coordinates(): restrict area in which identifier-pixels are considered "valid"

limit_to_range(): replace values outside of boundaries with respective boundary

prepare_resultsObject(): prepare the dataframe-object into which all results are to be merged.

validate_custom_HSV_values(): ensure that custom HSV values are within required range

.main_args(): pseudo-function to define default parameter documentation

State management

restore_state(): restore application state from stored .RDS-file

save_error_state(): Handle saving application-state to file

save_state(): Handle saving application-state to file

Parallelisation

setup_parallel(): setup parallel backend for a given number of cores.

shutdown_parallel(): shut down existing parallel cluster

Saving results

store_KPI_plot_to_file(): save KPI-plot to file

store_results_to_file(): write results of the analysis to file

update_resultsObject(): adds a line of values newline to a df resultsObject