.. automodule:: mw_plot.matplotlib_backend

Face-On View of Milky Way
==============================

Introduction
------------------

``MWFaceOn`` class is a wrapper around the ``matplotlib`` library to plot the face-on view of 
the Milky Way. It provides a simple interface to plot the face-on view of the Milky Way.

MilkyWay Bird's Eye
---------------------

.. code-block:: python

    >>> import numpy as np
    >>> from astropy import units as u
    >>> from mw_plot import MWFaceOn

    >>> mw1 = MWFaceOn(
    ...     radius=20 * u.kpc,
    ...     unit=u.kpc,
    ...     coord="galactocentric",
    ...     annotation=True,
    ...     figsize=(10, 8),
    ... )
    >>> mw1.title = "Bird's Eyes View"
    >>> mw1.scatter(8 * u.kpc, 0 * u.kpc, c="r", s=2)

..
    >>> import matplotlib.pyplot as plt
    >>> plt.close("all")

.. image:: mpl_imgs/mw_faceon.jpg
    :width: 500
    :align: center

Annotation and Grayscale
^^^^^^^^^^^^^^^^^^^^^^^^^^

If you set annotation to True, the annotation of the Milky Way components will be shown.

.. image:: mpl_imgs/mw_faceon_annotated.jpg
    :width: 500
    :align: center

If you set grayscale to True, the image will be shown in grayscale.

.. image:: mpl_imgs/mw_faceon_grayscale.jpg
    :width: 500
    :align: center

Coordinates and units
^^^^^^^^^^^^^^^^^^^^^^

Class API
---------------

.. autoclass:: mw_plot.MWFaceOn
    :members: