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

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

.. _sphx_glr_auto_examples_pac_plot_readme.py:


==============
README example
==============

Reproduced the figure in the README.



.. image:: /auto_examples/pac/images/sphx_glr_plot_readme_001.png
    :class: sphx-glr-single-img





.. code-block:: default

    from tensorpac import Pac
    from tensorpac.signals import pac_signals_tort

    import matplotlib.pyplot as plt

    # Dataset of signals artificially coupled between 10hz and 100hz :
    n_epochs = 20   # number of trials
    n_times = 4000  # number of time points
    sf = 512.       # sampling frequency

    # Create artificially coupled signals using Tort method :
    data, time = pac_signals_tort(f_pha=10, f_amp=100, noise=2, n_epochs=n_epochs,
                                  dpha=10, damp=10, sf=sf, n_times=n_times)

    # Define a Pac object
    p = Pac(idpac=(6, 0, 0), f_pha='hres', f_amp='hres')
    # Filter the data and extract pac
    xpac = p.filterfit(sf, data)

    # plot your Phase-Amplitude Coupling :
    p.comodulogram(xpac.mean(-1), cmap='Spectral_r', plotas='contour', ncontours=5,
                   title=r'10hz phase$\Leftrightarrow$100Hz amplitude coupling',
                   fz_title=14, fz_labels=13)
    # export the figure
    # plt.savefig('readme.png', bbox_inches='tight', dpi=300)
    p.show()


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

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


.. _sphx_glr_download_auto_examples_pac_plot_readme.py:


.. only :: html

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



  .. container:: sphx-glr-download

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



  .. container:: sphx-glr-download

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


.. only:: html

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

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