Source.Utils package

Submodules

Source.Utils.analysis_parameters module

Created on Mon Mar 22 11:26:36 2021

@author: ikaheia1

A helper class for storing the parameters used in the analysis. The parameters are stored in the __dict__ dictionary by using an alias name as the key.

class Source.Utils.analysis_parameters.AnalysisParameters

Bases: object

add(alias, parameter)

Adds a new key : value pair in __dict__ dictionary.

Parameters

• alias (str) – Alias name / key for the parameter

• parameter (str / int / list) – A parameter used as an argument for analysis functions.

Returns

Return type

None.

list_parameters()

Return a dictionaty containing the key : value pairs used as function parameters.

Returns

names – key : value pairs used as function arguments.

Return type

dict

Source.Utils.argument_loader module

Source.Utils.doi2int module

Source.Utils.file_names module

Created on Mon Mar 22 11:26:36 2021

@author: ikaheia1

A helper class for storing the filenames / paths used in the analysis. The filenames are stored in the __dict__ dictionary by using an alias name as the key.

class Source.Utils.file_names.FileNames

Bases: object

add(alias, filename)

Adds a new key : value pair in __dict__ dictionary.

Parameters

• alias (str) – Alias name / key for the filename

• parameter (str / Path) – A parameter used as a filename / Path for saving the figures.

Returns

Return type

None.

list_filenames()

Return a dictionaty containing the key : value pairs used as filenames or paths for data loading and saving the plotted figures.

Returns

names – key : value pairs used as filenames.

Return type

dict

Source.Utils.plot_decorator module

Source.Utils.process_decorator module

Module contents