******************
autom8qc.qaqc.peak
******************

ScipyPeakTest
=============

Class
-----

.. autoclass:: autom8qc.qaqc.peak.ScipyPeakTest
   :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, 1.5
   values = np.random.normal(mu, sigma, 500)
   values[42] = 55
   values[275] = 42
   index = pd.date_range(start="1/1/2021", periods=500, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.peak import ScipyPeakTest
   test = ScipyPeakTest(prominence=7.5, only_positive=False)
   test.plot(series=series, series_name="Example")


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

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