*********************
autom8qc.qaqc.outlier
*********************

GeneralizedESDTest
==================

Class
-----

.. autoclass:: autom8qc.qaqc.outlier.GeneralizedESDTest
   :members:
   :show-inheritance:

Example
-------

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   np.random.seed(42)
   mu, sigma = 55, 3
   values = np.random.normal(mu, sigma, 1000)
   values[42] = 70
   values[666] = 40
   index = pd.date_range(start="1/1/2021", periods=1000, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.outlier import GeneralizedESDTest
   test = GeneralizedESDTest(max_outliers=2, alpha=0.05)
   test.plot(series=series, series_name="Example")


Visualization
-------------

.. figure:: ./figures/GeneralizedESDTest.svg
   :width: 100%

LOFTest
=======

Class
-----

.. autoclass:: autom8qc.qaqc.outlier.LOFTest
   :members:
   :show-inheritance:

Example
-------

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   np.random.seed(42)
   mu, sigma = 55, 3
   values = np.random.normal(mu, sigma, 1000)
   values[42] = 70
   values[666] = 40
   index = pd.date_range(start="1/1/2021", periods=1000, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.outlier import LOFTest
   test = LOFTest(neighbors=100, contamination=0.002)
   test.plot(series=series, series_name="Example")

Visualization
-------------

.. figure:: ./figures/LOFTest.svg
   :width: 100%

OutlierIQRTest
==============

Class
-----

.. autoclass:: autom8qc.qaqc.outlier.OutlierIQRTest
   :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, 5
   values = np.random.normal(mu, sigma, 1000)
   values[42] = 70
   values[666] = 40
   index = pd.date_range(start="1/1/2021", periods=1000, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.outlier import OutlierIQRTest
   test = OutlierIQRTest()
   test.plot(series=series, series_name="Example")

Visualization
-------------

.. figure:: ./figures/OutlierIQRTest.svg
   :width: 100%

OutlierMADTest
==============

Class
-----

.. autoclass:: autom8qc.qaqc.outlier.OutlierMADTest
   :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, 5
   values = np.random.normal(mu, sigma, 1000)
   values[42] = 70
   values[666] = 40
   index = pd.date_range(start="1/1/2021", periods=1000, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.outlier import OutlierMADTest
   test = OutlierMADTest()
   test.plot(series=series, series_name="Example")

Visualization
-------------

.. figure:: ./figures/OutlierMADTest.svg
   :width: 100%

OutlierZTest
============

Class
-----

.. autoclass:: autom8qc.qaqc.outlier.OutlierZTest
   :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, 5
   values = np.random.normal(mu, sigma, 1000)
   values[42] = 70
   values[666] = 40
   index = pd.date_range(start="1/1/2021", periods=1000, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.outlier import OutlierZTest
   test = OutlierZTest()
   test.plot(series=series, series_name="Example")

Visualization
-------------

.. figure:: ./figures/OutlierZTest.svg
   :width: 100%