pyHarm.Correctors.FactoryCorrector

This is the factory of the ABCCorrector subclasses.

pyHarm.Correctors.FactoryCorrector.Corrector_dico

Dictionary containing the ABCCorrector subclasses as values and their factory_keyword as key.

Type:

dict[str, ABCCorrector]

Attributes

Corrector_dico

Dictionary containing the ABCCorrector subclasses as values and their factory_keyword as key.

Functions

generateCorrector(...)

Factory function that creates an ABCCorrector object.

Module Contents

pyHarm.Correctors.FactoryCorrector.Corrector_dico

Dictionary containing the ABCCorrector subclasses as values and their factory_keyword as key.

Type:

dict[str, ABCCorrector]

pyHarm.Correctors.FactoryCorrector.generateCorrector(name_corrector, corrector_options) pyHarm.Correctors.ABCCorrector.ABCCorrector

Factory function that creates an ABCCorrector object.

Parameters:
  • name_corrector (str) – Type of the ABCCorrector object that is to be instantiated.

  • corrector_options (dict) – supplementary options passed to the corrector.

Returns:

Instance of the required ABCCorrector class.

Return type:

ABCCorrector