src.dackar.anomalies.plotUtils
==============================

.. py:module:: src.dackar.anomalies.plotUtils


Attributes
----------

.. autoapisummary::

   src.dackar.anomalies.plotUtils.logger
   src.dackar.anomalies.plotUtils.fontsize


Functions
---------

.. autoapisummary::

   src.dackar.anomalies.plotUtils.plot_data
   src.dackar.anomalies.plotUtils.plot_kdp
   src.dackar.anomalies.plotUtils.plot_anomaly


Module Contents
---------------

.. py:data:: logger

.. py:data:: fontsize
   :value: '12'


.. py:function:: plot_data(df, mp, title='Data vs. Matrix Profile', sharex=True, gridspec_kw={'hspace': 0})

   plot data from pandas dataframe (column-wise)

   :param df: data
   :type df: pandas.dataframe
   :param title: title for the plot. Defaults to ''.
   :type title: str, optional
   :param sharex: share x-axis. Defaults to True.
   :type sharex: bool, optional
   :param gridspec_kw: grid option for plots. Defaults to {'hspace':0}.
   :type gridspec_kw: dict, optional


.. py:function:: plot_kdp(df, title='K-Dimensional Profile', sharex=True, gridspec_kw={'hspace': 0})

   plot K-dimensional profile from pandas dataframe (column-wise)

   :param df: K-dimensional profile
   :type df: pandas.dataframe
   :param title: title for the plot. Defaults to ''.
   :type title: str, optional
   :param sharex: share x-axis. Defaults to True.
   :type sharex: bool, optional
   :param gridspec_kw: grid option for plots. Defaults to {'hspace':0}.
   :type gridspec_kw: dict, optional


.. py:function:: plot_anomaly(df, mps, anomalies_idx, m, title=None, sharex=True, gridspec_kw={'hspace': 0})

   Plot anomalies for given data

   :param df: _description_
   :type df: pandas.DataFrame
   :param mps: dictionary of matrix profiles of df
   :type mps: dict
   :param anomalies_idx: dictionary of anomaly indices
   :type anomalies_idx: dict
   :param m: length of slide window
   :type m: int
   :param title: title for the plot. Defaults to None.
   :type title: str, optional
   :param sharex: share x-axis. Defaults to True.
   :type sharex: bool, optional
   :param gridspec_kw: _description_. Defaults to {'hspace':0}.
   :type gridspec_kw: dict, optional