:orphan:

.. _examples:

########
Examples
########

This page contains small code snippets with examples for several ``madcubapy``
classes and functions.

If you are inexperienced with the ``madcubapy`` package, check the
:ref:`Tutorials <tutorials>` page for fully fledged examples suited for
begginers on how to work with ``madcubapy`` from scratch.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Maps
====

Gallery of examples for map related classes and functions.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example showing how to read a fits map file as a MadcubaMap.">

.. only:: html

  .. image:: /gallery_examples/maps/images/thumb/sphx_glr_read_map_thumb.png
    :alt:

  :doc:`/gallery_examples/maps/read_map`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Read a FITS file with MadcubaMap</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example showing how to plot a fits map file with MadcubaMap using add_wcs_axes.">

.. only:: html

  .. image:: /gallery_examples/maps/images/thumb/sphx_glr_plot_map_thumb.png
    :alt:

  :doc:`/gallery_examples/maps/plot_map`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot a map</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example showing how to quickly add a colorbar to a map plot. ">

.. only:: html

  .. image:: /gallery_examples/maps/images/thumb/sphx_glr_add_colorbar_thumb.png
    :alt:

  :doc:`/gallery_examples/maps/add_colorbar`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Add a colorbar to a map</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example showing how to plot several fits map files with MadcubaMap using add_wcs_axes.">

.. only:: html

  .. image:: /gallery_examples/maps/images/thumb/sphx_glr_plot_maps_thumb.png
    :alt:

  :doc:`/gallery_examples/maps/plot_maps`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot several maps</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example showing how to synchromnize the zoom level (axes limits) of several FITS map files using sync_zoom.">

.. only:: html

  .. image:: /gallery_examples/maps/images/thumb/sphx_glr_sync_maps_thumb.png
    :alt:

  :doc:`/gallery_examples/maps/sync_maps`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Sync map zoom</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Regions
=======

Gallery of examples for region related functions.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example showing how to import RoIs from other programs with import_roi.">

.. only:: html

  .. image:: /gallery_examples/regions/images/thumb/sphx_glr_import_a_region_thumb.png
    :alt:

  :doc:`/gallery_examples/regions/import_a_region`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Import Regions of Interest (RoIs)</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /gallery_examples/maps/index.rst
   /gallery_examples/regions/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

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

      :download:`Download all examples in Python source code: gallery_examples_python.zip </gallery_examples/gallery_examples_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: gallery_examples_jupyter.zip </gallery_examples/gallery_examples_jupyter.zip>`


.. only:: html

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

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