*******************
autom8qc.qaqc.limit
*******************

GlobalMinimumTest
=================

Class
-----

.. autoclass:: autom8qc.qaqc.limit.GlobalMinimumTest
   :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, 4
   values = np.random.normal(mu, sigma, 300)
   index = pd.date_range(start="1/1/2021", periods=300, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.limit import GlobalMinimumTest
   test = GlobalMinimumTest(min_val=43, min_lim=42)
   test.plot(series=series, series_name="Example")


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

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


GlobalMaximumTest
=================

Class
-----

.. autoclass:: autom8qc.qaqc.limit.GlobalMaximumTest
   :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, 300)
   index = pd.date_range(start="1/1/2021", periods=300, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.limit import GlobalMaximumTest
   test = GlobalMaximumTest(max_val=59, max_lim=60)
   test.plot(series=series, series_name="Example")

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

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

GlobalRangeTest
===============

Class
-----

.. autoclass:: autom8qc.qaqc.limit.GlobalRangeTest
   :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, 2
   values = np.random.normal(mu, sigma, 300)
   index = pd.date_range(start="1/1/2021", periods=300, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.limit import GlobalRangeTest
   test = GlobalRangeTest(min_lim=46, min_val=47, max_val=54, max_lim=55)
   test.plot(series=series, series_name="Example")

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

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