.. _autom8qc.functions:

******************
autom8qc.functions
******************

autom8qc.functions.base
=======================

BaseFunction
------------

.. autoclass:: autom8qc.functions.base.BaseFunction
   :members:
   :show-inheritance:

ListFunction
------------

Class
^^^^^
.. autoclass:: autom8qc.functions.base.ListFunction
   :members:
   :show-inheritance:

Example
^^^^^^^

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   np.random.seed(42)
   mu, sigma = 50, 3
   values = np.random.normal(mu, sigma, 20)
   values[[2, 3, 5, 7]] = -9999
   index = pd.date_range(start="1/1/2021", periods=20, freq="2min")
   series = pd.Series(values, index=index)

   from autom8qc.functions.base import ListFunction
   from autom8qc.functions.general import ReplaceMissingsFunction
   from autom8qc.functions.interpolation import InterpolationFunction
   function_a = ReplaceMissingsFunction(value=-9999)
   function_b = InterpolationFunction(method="nearest")
   function = ListFunction(function_a, function_b)
   function.plot(series)


Visualization
^^^^^^^^^^^^^

   .. figure:: ./functions/ListFunction.svg
      :width: 100%

autom8qc.functions.general
==========================

ReplaceMissingsFunction
-----------------------

Class
^^^^^
.. autoclass:: autom8qc.functions.general.ReplaceMissingsFunction
   :members:
   :show-inheritance:

Example
^^^^^^^

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   np.random.seed(42)
   mu, sigma = 50, 3
   values = np.random.normal(mu, sigma, 20)
   values[[2, 3, 5, 7]] = -9999
   index = pd.date_range(start="1/1/2021", periods=20, freq="2min")
   series = pd.Series(values, index=index)

   from autom8qc.functions.general import ReplaceMissingsFunction
   function = ReplaceMissingsFunction(value=-9999)
   function.plot(series)

Visualization
^^^^^^^^^^^^^

   .. figure:: ./functions/ReplaceMissingsFunction.svg
      :width: 100%


autom8qc.functions.interpolation
================================

FillValidityGapsFunction
------------------------

Class
^^^^^
.. autoclass:: autom8qc.functions.interpolation.FillValidityGapsFunction
   :members:
   :show-inheritance:

Example
^^^^^^^

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   from autom8qc.core.validities import StandardValidities
   np.random.seed(42)
   validities = StandardValidities()
   ids = np.random.randint(4, size=50)
   values = np.array([validities.ALL_VALIDITIES[id] for id in ids])
   values[10:20] = validities.MISSING
   index = pd.date_range(start="1/1/2021", periods=50, freq="1min")
   series = pd.Series(values, index=index)

   from autom8qc.functions.interpolation import FillValidityGapsFunction
   function = FillValidityGapsFunction(time_delta=5, validities=validities, method="worst")
   function.plot(series)

Visualization
^^^^^^^^^^^^^

   .. figure:: ./functions/FillValidityGapsFunction.svg
      :width: 100%

InterpolationFunction
---------------------

Class
^^^^^
.. autoclass:: autom8qc.functions.interpolation.InterpolationFunction
   :members:
   :show-inheritance:

Example
^^^^^^^

   .. code-block:: python

      # Generate sample data
      import numpy as np
      import pandas as pd
      np.random.seed(42)
      mu, sigma = 50, 3
      values = np.random.normal(mu, sigma, 100)
      index = pd.date_range(start="1/1/2021", periods=100, freq="2min")
      series = pd.Series(values, index=index)

      from autom8qc.functions.interpolation import InterpolationFunction
      function = InterpolationFunction(method="linear", resolution="30s")
      function.plot(series)

Visualization
^^^^^^^^^^^^^

   .. figure:: ./functions/InterpolationFunction.svg
      :width: 100%