src.dackar.anomalies.MatrixProfile
==================================

.. py:module:: src.dackar.anomalies.MatrixProfile


Attributes
----------

.. autoapisummary::

   src.dackar.anomalies.MatrixProfile.logger
   src.dackar.anomalies.MatrixProfile.DASK_CLIENT_AVAIL
   src.dackar.anomalies.MatrixProfile.DASK_CLIENT_AVAIL


Classes
-------

.. autoapisummary::

   src.dackar.anomalies.MatrixProfile.MatrixProfile


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

.. py:data:: logger

.. py:data:: DASK_CLIENT_AVAIL
   :value: False


.. py:data:: DASK_CLIENT_AVAIL
   :value: True


.. py:class:: MatrixProfile(m, normalize='robust', method='normal', kdp=False, approx_percentage=0.1, sub_sequence_normalize=False, excl_zone_denom=4)

   Bases: :py:obj:`src.dackar.anomalies.AnomalyBase.AnomalyBase`


   _summary_

   :param AnomalyBase: _description_
   :type AnomalyBase: _type_


   .. py:attribute:: _m


   .. py:attribute:: _norm
      :value: 'robust'



   .. py:attribute:: _sub_norm
      :value: False



   .. py:attribute:: _mp


   .. py:attribute:: _avail_method
      :value: ['normal', 'parallel', 'approx', 'incremental', 'gpu']



   .. py:attribute:: _method
      :value: ''



   .. py:attribute:: _scrump_percentage
      :value: 0.1



   .. py:attribute:: _current_idx
      :value: []



   .. py:attribute:: _norm_plot
      :value: True



   .. py:attribute:: _compute_kdp
      :value: False



   .. py:attribute:: _kdp


   .. py:method:: _fit(X, y=None)

      perform fitting

      :param X: (n_time_steps, n_features)
      :type X: pandas.DataFrame
      :param y: ignored, (n_time_steps, n_features). Defaults to None.
      :type y: pandas.DataFrame, optional



   .. py:method:: _compute_mp(X_, y_=None)

      compute matrix profile

      :param X_: (n_time_steps, n_features)
      :type X_: pandas.DataFrame
      :param y_: ignored, (n_time_steps, n_features). Defaults to None.
      :type y_: pandas.DataFrame, optional



   .. py:method:: _evaluate(X)

      perform evaluation

      :param X_: (n_time_steps, n_features)
      :type X_: pandas.DataFrame



   .. py:method:: plot()

      plot data




   .. py:method:: plot_kdp()

      plot data




   .. py:method:: get_mp()

      get matrix profile value




   .. py:method:: get_mp_index()

      get matrix profile index




   .. py:method:: get_mp_left_index()

      get left matrix profile index




   .. py:method:: get_mp_right_index()

      get right matrix profile index