wf_psf.metrics.metrics_config_handler

MetricsConfigHandler.

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

Authors:: Jennifer Pollack <jennifer.pollack@cea.fr>

Classes

MetricsConfigHandler(metrics_conf, file_handler)

MetricsConfigHandler.

class wf_psf.metrics.metrics_config_handler.MetricsConfigHandler(metrics_conf, file_handler, training_conf=None)[source]

Bases: ConfigHandler

MetricsConfigHandler.

A class to handle metrics configuation parameters.

Parameters:

ids (tuple) – A tuple containing a string id for the Configuration Class
metrics_conf (str) – Path to the metrics configuration file
file_handler (object) – An instance of the FileIOHandler
training_conf (RecursiveNamespace object) – RecursiveNamespace object containing the training configuration parameters

Attributes:

metrics_conf: Get Metrics Conf.
plotting_conf: Get Plotting Conf.
training_conf: Returns the loaded training configuration.

Methods

`call_plot_config_handler_run`(model_metrics)	Make Metrics Plots.
`run`()	Run.

call_plot_config_handler_run(model_metrics)[source]

Make Metrics Plots.

A function to call the PlottingConfigHandler run command to generate metrics plots.

Parameters:: model_metrics (dict) – A dictionary storing the metrics output generated during evaluation of the trained PSF model.

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

property metrics_conf

Get Metrics Conf.

A function to return the metrics configuration file name.

Returns:: An instance of the metrics configuration file.
Return type:: RecursiveNamespace

property plotting_conf

Get Plotting Conf.

A function to return the plotting configuration file name.

Returns:: Name of plotting configuration file
Return type:: str

run()[source]

Run.

A function to run WaveDiff according to the input configuration.

property training_conf: Returns the loaded training configuration.