.. _autom8qc.mappers:

****************
autom8qc.mappers
****************

autom8qc.mappers.actris
=======================

ACTRISStandardMapper
--------------------

Class
^^^^^
.. autoclass:: autom8qc.mappers.actris.ACTRISStandardMapper
   :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)
   values[[7, 19, 42, 93, 211]] = np.nan
   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=42, min_lim=40)
   probabilities = test.perform(series)

   # Map the probabilities
   from autom8qc.mappers.actris import ACTRISStandardMapper
   mapper = ACTRISStandardMapper(invalid_flag="666")
   mapper.plot(series, probabilities)

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

   .. figure:: ./mappers/ACTRISStandardMapper.svg
      :width: 100%


Logical2ACTRISMapper
--------------------

Class
^^^^^

   .. autoclass:: autom8qc.mappers.actris.Logical2ACTRISMapper
      :members:
      :show-inheritance:

Example
^^^^^^^

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   values = np.random.randint(2, size=100).astype(bool)
   index = pd.date_range(start="1/1/2021", periods=100, freq="min")
   series = pd.Series(values, index=index)

   # Map the probabilities
   from autom8qc.mappers.actris import Logical2ACTRISMapper
   mapper = Logical2ACTRISMapper(invalid_flag="666")
   mapper.plot(series, series)


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

   .. figure:: ./mappers/Logical2ACTRISMapper.svg
      :width: 100%


autom8qc.mappers.base
=====================

BaseMapper
----------

.. autoclass:: autom8qc.mappers.base.BaseMapper
   :members:
   :show-inheritance:

ListMapper
----------

Class
^^^^^
.. autoclass:: autom8qc.mappers.base.ListMapper
   :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 GlobalMinimumTest
   test = GlobalMinimumTest(min_val=42, min_lim=40)
   probabilities = test.perform(series)

   # Map the probabilities
   from autom8qc.core.validities import StandardValidities
   from autom8qc.core.validities import ValidityContainer
   from autom8qc.mappers.base import ListMapper
   from autom8qc.mappers.validities import StandardValidityMapper
   from autom8qc.mappers.validities import ValidityContainerMapper
   iagos_validities = ValidityContainer(0, 2, 3, 4, 7)
   mapper_a = StandardValidityMapper(good_limit=0.8, limited_limit=0.3)
   mapper_b = ValidityContainerMapper(StandardValidities(), iagos_validities)
   mapper = ListMapper(mapper_a, mapper_b)
   mapper.plot(series, probabilities)

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

   .. figure:: ./mappers/ListMapper.svg
      :width: 100%

autom8qc.mappers.logical
========================

Logical2ValidityMapper
----------------------

Class
^^^^^
.. autoclass:: autom8qc.mappers.logical.Logical2ValidityMapper
   :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) < 50
   index = pd.date_range(start="1/1/2021", periods=300, freq="min")
   series = pd.Series(values, index=index, dtype=bool)

   # Map the probabilities
   from autom8qc.mappers.logical import Logical2ValidityMapper
   mapper = Logical2ValidityMapper()
   mapper.plot(series, series)

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

.. figure:: ./mappers/Logical2ValidityMapper.svg
   :width: 100%

LogicalThresholdMapper
----------------------

Class
^^^^^
.. autoclass:: autom8qc.mappers.logical.LogicalThresholdMapper
   :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=50)
   probabilities = test.perform(series)

   # Map the probabilities
   from autom8qc.mappers.logical import LogicalThresholdMapper
   mapper = LogicalThresholdMapper(threshold=0.5, force_nan=False)
   mapper.plot(series, probabilities)

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

.. figure:: ./mappers/LogicalThresholdMapper.svg
   :width: 100%


autom8qc.mappers.validities
===========================

StandardValidityMapper
----------------------

Class
^^^^^
.. autoclass:: autom8qc.mappers.validities.StandardValidityMapper
   :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 GlobalMinimumTest
   test = GlobalMinimumTest(min_val=42, min_lim=40)
   probabilities = test.perform(series)

   # Map the probabilities
   from autom8qc.mappers.validities import StandardValidityMapper
   mapper = StandardValidityMapper(good_limit=0.8, limited_limit=0.3)
   mapper.plot(series, probabilities)

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

.. figure:: ./mappers/StandardValidityMapper.svg
   :width: 100%

ValidityContainerMapper
-----------------------

Class
^^^^^
.. autoclass:: autom8qc.mappers.validities.ValidityContainerMapper
   :members:
   :show-inheritance:

Example
^^^^^^^

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   np.random.seed(42)
   probabilities = np.random.rand(100)
   index = pd.date_range(start="1/1/2021", periods=100, freq="min")
   series = pd.Series(probabilities, index=index)

   # Map probabilities to standard validities
   from autom8qc.mappers.validities import StandardValidityMapper
   mapper = StandardValidityMapper(good_limit=0.6, limited_limit=0.3)
   validities = mapper.map(series)

   # Create container for IAGOS validities
   from autom8qc.core.validities import ValidityContainer
   iagos_validities = ValidityContainer(0, 2, 3, 4, 7)

   # Map the probabilities
   from autom8qc.core.validities import StandardValidities
   from autom8qc.mappers.validities import ValidityContainerMapper
   mapper = ValidityContainerMapper(StandardValidities(), iagos_validities)
   mapper.plot(validities, validities)

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

.. figure:: ./mappers/ValidityContainerMapper.svg
   :width: 100%