.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/detect/plot_cusum.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        Click :ref:`here <sphx_glr_download_auto_examples_detect_plot_cusum.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_detect_plot_cusum.py:


==================================================
Change Point Detection with Cusum
==================================================

Example of change point detection based on the cusum algorithm.
We use synthetic data generated from a standard normal distribution of mean 0 and variance 1 with a shift in some of the datapoints to simulate a change in the mean of the data.

In the figure below it can be observed how the Cusum algorithm identifies increasing and decreasing change point segments.
The input parameters used by the algorithm in this example are:

    - threshold = 4 →  Specifies the amplitid threshold for the change in data.
    - drift = 1.5 → Specifies the drift term that prevents any change in the absence of change.
    - alpha = 0.05 → Specifies the smoothing factor of the data.
    - detect = "both" → Specifies the type of changes to detect: both increasing and decreasing.
    - predict_ending = True → Predicts the end point of the change.
    - plot_cusum = True →  Plots 2 figures containing the following data:
        1. Raw data, smoothed data, detected change points, start of the change and end of the change (if ending = True).
        2. Cumulative sums for increasing and decreasing changes.

.. GENERATED FROM PYTHON SOURCE LINES 22-52



.. rst-class:: sphx-glr-horizontal


    *

      .. image-sg:: /auto_examples/detect/images/sphx_glr_plot_cusum_001.png
         :alt: Detected changes in the data (threshold= 4, drift= 1.5): N changes =3, Cumulative sums of increasing and decreasing changes.
         :srcset: /auto_examples/detect/images/sphx_glr_plot_cusum_001.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /auto_examples/detect/images/sphx_glr_plot_cusum_002.png
         :alt: Binary results from cusum
         :srcset: /auto_examples/detect/images/sphx_glr_plot_cusum_002.png
         :class: sphx-glr-multi-img





.. code-block:: default


    import matplotlib.pyplot as plt
    import numpy as np
    import pandas as pd

    from matplotlib.dates import DateFormatter

    from indsl.detect.cusum import Cusum


    # generate synthetic data with shift
    y = np.random.randn(300)
    y[100:200] += 6
    index = pd.date_range(start="1970", periods=300, freq="1T")
    raw_data = pd.Series(y, index=index)

    # get cusum results and plot the intermidiate figures
    res = Cusum(raw_data, threshold=4, drift=1.5, detect="both", predict_ending=True).cusum(plot_cusum=True)

    # Plot the raw data and the resulting binary pd.Series returned from the cusum
    fig, ax = plt.subplots(1, 1, figsize=[15, 5])
    ax.plot(raw_data, label="Raw data")
    ax.plot(res, label="Result")
    ax.set_title("Binary results from cusum")
    _ = ax.legend(loc="best")
    # Formatting
    myFmt = DateFormatter("%b %d, %H:%M")
    ax.xaxis.set_major_formatter(myFmt)
    ax.xaxis.set_major_formatter(DateFormatter("%b %d, %H:%M"))
    _ = plt.setp(ax.get_xticklabels(), rotation=45)


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  28.644 seconds)


.. _sphx_glr_download_auto_examples_detect_plot_cusum.py:


.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-example



  .. container:: sphx-glr-download sphx-glr-download-python

     :download:`Download Python source code: plot_cusum.py <plot_cusum.py>`



  .. container:: sphx-glr-download sphx-glr-download-jupyter

     :download:`Download Jupyter notebook: plot_cusum.ipynb <plot_cusum.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_