wf_psf.plotting.plotting_config_handler

PlottingConfigHandler.

A module containing the PlottingConfigHandler class, which is responsible for managing the parameters of the plotting configuration file and running the plotting of the metrics of a trained PSF model

Authors:

Jennifer Pollack <jennifer.pollack@cea.fr>

Classes

PlottingConfigHandler(plotting_conf, ...)

PlottingConfigHandler.

class wf_psf.plotting.plotting_config_handler.PlottingConfigHandler(plotting_conf, file_handler)

Bases: ConfigHandler

PlottingConfigHandler.

A class to handle plotting config settings.

Parameters:

• ids (tuple) – A tuple containing a string id for the Configuration Class

• plotting_conf (str) – Name of plotting configuration file

• file_handler (obj) – An instance of the FileIOHandler class

Methods

check_and_update_metrics_confs()	Check and Update Metrics Confs.
load_metrics_into_dict()	Load Metrics into Dictionary.
make_dict_of_metrics()	Make dictionary of metrics.
run()	Run.

check_and_update_metrics_confs()

Check and Update Metrics Confs.

A function to check if user provided inputs metrics dir to add to metrics_confs dictionary.

ids: tuple[str, ...] = ('plotting_conf',)

load_metrics_into_dict()

Load Metrics into Dictionary.

A method to load a metrics file of a trained model from a previous run into a dictionary.

Returns:

metrics_files_dict – A dictionary containing all of the metrics from the loaded metrics files.

Return type:

dict

make_dict_of_metrics()

Make dictionary of metrics.

A function to create a dictionary for each metrics per run.

Returns:

A dictionary containing metrics or an empty dictionary.

Return type:

dict

run()

Run.

A function to run wave-diff according to the input configuration.