.. only:: html

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

        Click :ref:`here <sphx_glr_download_auto_examples_plot_peak_locking.py>`     to download the full example code
    .. rst-class:: sphx-glr-example-title

    .. _sphx_glr_auto_examples_plot_peak_locking.py:


Peak-locking
------------
The peaks are extracted from the low frequency band, then both the raw-signal
and a time-frequency representation are peak-locked and averaged.

Note the effect of the bandwidth `low_fq_width` on the number of
oscillations in the results.


.. code-block:: default

    import matplotlib.pyplot as plt

    from pactools import PeakLocking
    from pactools import simulate_pac









Let's first create an artificial signal with PAC.


.. code-block:: default


    fs = 200.  # Hz
    high_fq = 50.0  # Hz
    low_fq = 3.0  # Hz
    low_fq_width = 2.0  # Hz

    n_points = 10000
    noise_level = 0.4
    t_plot = 2.0  # sec

    signal = simulate_pac(n_points=n_points, fs=fs, high_fq=high_fq, low_fq=low_fq,
                          low_fq_width=low_fq_width, noise_level=noise_level,
                          random_state=0)








Plot the amplitude of each frequency, locked with the peak of the slow wave


.. code-block:: default


    estimator = PeakLocking(fs=fs, low_fq=low_fq, low_fq_width=2.0, t_plot=t_plot)
    estimator.fit(signal)
    estimator.plot()

    estimator = PeakLocking(fs=fs, low_fq=low_fq, low_fq_width=0.5, t_plot=t_plot)
    estimator.fit(signal)
    estimator.plot()

    plt.show()



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


    *

      .. image:: /auto_examples/images/sphx_glr_plot_peak_locking_001.png
            :class: sphx-glr-multi-img

    *

      .. image:: /auto_examples/images/sphx_glr_plot_peak_locking_002.png
            :class: sphx-glr-multi-img


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

 Out:

 .. code-block:: none

    /home/tom/work/github/pactools/examples/plot_peak_locking.py:43: UserWarning: Matplotlib is currently using agg, which is a non-GUI backend, so cannot show the figure.
      plt.show()





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

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


.. _sphx_glr_download_auto_examples_plot_peak_locking.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_peak_locking.py <plot_peak_locking.py>`



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

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


.. only:: html

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

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