pyHarm.Predictors.FactoryPredictor
==================================

.. py:module:: pyHarm.Predictors.FactoryPredictor

.. autoapi-nested-parse::

   This module contains the factory of the predictor objects.

   .. attribute:: Predictor_dico

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

      :type: dict



Attributes
----------

.. autoapisummary::

   pyHarm.Predictors.FactoryPredictor.Predictor_dico


Functions
---------

.. autoapisummary::

   pyHarm.Predictors.FactoryPredictor.generatePredictor


Module Contents
---------------

.. py:data:: Predictor_dico

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

   :type: dict

.. py:function:: generatePredictor(name_predictor, sign_ds, logger: Optional[logging.Logger] = None, predictor_options: dict = dict()) -> pyHarm.Predictors.ABCPredictor.ABCPredictor

   Factory function that creates a ABCPredictor object.

   :param name_predictor: Type of the ABCPredictor object that is to be instantiated.
   :type name_predictor: str
   :param sign_ds: either -1 or 1, gives the initial direction of prediction.
   :type sign_ds: float
   :param predictor_options: dictionary containing supplementary options for the predictor to be instantiated
   :type predictor_options: dict

   :returns: Instance of the required ABCPredictor class.
   :rtype: ABCPredictor