pyHarm.Predictors.FactoryPredictor

This module contains the factory of the predictor objects.

pyHarm.Predictors.FactoryPredictor.Predictor_dico

Dictionary that contains ABCPredictor objects as values and their factory_keyword attribute as their key.

Type:

dict

Attributes

Predictor_dico

Dictionary that contains ABCPredictor objects as values and their factory_keyword attribute as their key.

Functions

generatePredictor(...)

Factory function that creates a ABCPredictor object.

Module Contents

pyHarm.Predictors.FactoryPredictor.Predictor_dico

Dictionary that contains ABCPredictor objects as values and their factory_keyword attribute as their key.

Type:

dict

pyHarm.Predictors.FactoryPredictor.generatePredictor(name_predictor, sign_ds, predictor_options) pyHarm.Predictors.ABCPredictor.ABCPredictor

Factory function that creates a ABCPredictor object.

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

  • sign_ds (float) – either -1 or 1, gives the initial direction of prediction.

  • predictor_options (dict) – dictionary containing supplementary options for the predictor to be instantiated

Returns:

Instance of the required ABCPredictor class.

Return type:

ABCPredictor