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

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download_auto_examples_data_quality_plot_datapoint_diff.py>`
        to download the full example code

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

.. _sphx_glr_auto_examples_data_quality_plot_datapoint_diff.py:


===================================================================================
Threshold breach check for difference between two data points over a period of time
===================================================================================

Example of visualizing breach of threshold in hour count in a time series representing running hours of a piece of
equipment.

.. GENERATED FROM PYTHON SOURCE LINES 10-67



.. image-sg:: /auto_examples/data_quality/images/sphx_glr_plot_datapoint_diff_001.png
   :alt: Check if difference between two datapoints at a distance of 24 hours exceeds the threshold
   :srcset: /auto_examples/data_quality/images/sphx_glr_plot_datapoint_diff_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    /Users/vebjorngilberg/Documents/work/cognite/repos/indsl/indsl/equipment/volume_vessel.py:31: UserWarning: Couldn't import fluids.numba_vectorized: No module named 'fluids.vectorized'. Default to import fluids.vectorized.
      warnings.warn(






|

.. code-block:: default

    import os

    from datetime import datetime, timedelta

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

    from indsl.data_quality.datapoint_diff import datapoint_diff_over_time_period


    # import generated data
    base_path = "" if __name__ == "__main__" else os.path.dirname(__file__)
    data = pd.read_csv(os.path.join(base_path, "../../datasets/data/hour_count.csv"), index_col=0)
    data = data.squeeze()
    data.index = pd.to_datetime(data.index)

    # apply function to calculate difference between datapoint over a period of 1 day
    hour_count_default_threshold = datapoint_diff_over_time_period(data, pd.Timedelta("1D"), 24, pd.Timedelta("1H"))

    # Resample and forward fill generated step series
    resampled_step_series_default_threshold = hour_count_default_threshold.resample("60min")
    default_threshold_forward_filled = resampled_step_series_default_threshold.ffill()

    # Plot unchanged signal identification series against actual data
    fig, ax1 = plt.subplots(figsize=(15, 5))
    ax1.plot(data.index, data, label="Time series", marker=".", color="blue")

    values = np.arange(data.index[0], data.index[-1], timedelta(minutes=120)).astype(datetime)

    ax1.set_xticks(values)
    ax1.set_xticklabels([ts.strftime("%d-%m \n %H:%M") for ts in values], fontsize=8)

    ax2 = ax1.twinx()
    ax2.plot(
        data.index,
        default_threshold_forward_filled,
        label="Threshold breach indicator for datapoint diff over last 24 hours",
        marker=".",
        color="red",
    )

    lines1, labels1 = ax1.get_legend_handles_labels()
    lines2, labels2 = ax2.get_legend_handles_labels()
    ax2.legend(lines1 + lines2, labels1 + labels2, loc=0)

    plt.xlabel("Timestamp")
    ax1.set_ylabel("Timeseries value")
    ax2.set_ylabel("Hour count threshold breach")

    fig.suptitle(
        "Check if difference between two datapoints at a distance of 24 hours exceeds the threshold",
        fontsize=14,
    )
    fig.tight_layout()

    plt.show()


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

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


.. _sphx_glr_download_auto_examples_data_quality_plot_datapoint_diff.py:

.. only:: html

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




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

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

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

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


.. only:: html

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

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