.. only:: html

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

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

    .. _sphx_glr_auto_examples_quickflat_plot_rois.py:


========================
Plot ROIs on the flatmap
========================

ROIs are defined as sub-layers of the `roi` layer in
<filestore>/<subject>/overlays.svg

By default, ROIs and ROI labels are displayed when a flatmap is plotted using
`quickflat.make_figure`.

`with_labels=False` turns off the ROI labels.
`with_rois=False` turns off the ROI display.



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


    *

      .. image:: /auto_examples/quickflat/images/sphx_glr_plot_rois_001.png
          :alt: plot rois
          :class: sphx-glr-multi-img

    *

      .. image:: /auto_examples/quickflat/images/sphx_glr_plot_rois_002.png
          :alt: plot rois
          :class: sphx-glr-multi-img

    *

      .. image:: /auto_examples/quickflat/images/sphx_glr_plot_rois_003.png
          :alt: plot rois
          :class: sphx-glr-multi-img






.. code-block:: default

    import cortex
    import numpy as np
    import matplotlib.pyplot as plt
    np.random.seed(1234)

    # Create a random pycortex Volume
    volume = cortex.Volume.random(subject='S1', xfmname='fullhead')

    # Plot a flatmap with the data projected onto the surface
    # By default the ROIs and their labels will be displayed
    _ = cortex.quickflat.make_figure(volume)
    plt.show()

    # Turn off the ROI labels
    _ = cortex.quickflat.make_figure(volume, with_labels=False)
    plt.show()

    # Turn off the ROIs
    _ = cortex.quickflat.make_figure(volume, with_rois=False)
    plt.show()


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

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


.. _sphx_glr_download_auto_examples_quickflat_plot_rois.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_rois.py <plot_rois.py>`



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

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


.. only:: html

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

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