.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_examples/Basic_Plots/plot_ellipsod_on_image.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download__examples_Basic_Plots_plot_ellipsod_on_image.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr__examples_Basic_Plots_plot_ellipsod_on_image.py:


Plot geometrical model to an image
----------------------------------

In this example, we use PyThea's utilities to plot the ellipsoid model to a coronagraphic image from LASCO-C2. This example is a combination of two examples that show how to load, process, and plot an image and how to load a fitting file and construct the geometrical model.

.. GENERATED FROM PYTHON SOURCE LINES 9-10

Import Required Modules

.. GENERATED FROM PYTHON SOURCE LINES 10-24

.. code-block:: Python

    from datetime import datetime, timedelta

    import astropy.units as u
    import matplotlib.pyplot as plt
    from astropy.coordinates import SkyCoord
    from sunpy.coordinates import frames
    from sunpy.net import attrs as a

    from PyThea.config import selected_imagers
    from PyThea.data.sample_data import json_fitting_file_sample_data
    from PyThea.geometrical_models import ellipsoid
    from PyThea.utils import (download_fits, load_fits, make_figure,
                              model_fittings, single_imager_maps_process)








.. GENERATED FROM PYTHON SOURCE LINES 25-26

Select the imager and specify the time range of the query.

.. GENERATED FROM PYTHON SOURCE LINES 26-33

.. code-block:: Python


    imager = 'LC2'
    date_process = datetime.strptime('2021-10-28T16:30:00', '%Y-%m-%dT%H:%M:%S')
    time_range = [-1, 1]
    timerange = a.Time(date_process + timedelta(hours=time_range[0]),
                       date_process + timedelta(hours=time_range[1]))








.. GENERATED FROM PYTHON SOURCE LINES 34-35

Download the fits files from VSO using the ``download_fits`` utility.

.. GENERATED FROM PYTHON SOURCE LINES 35-39

.. code-block:: Python


    files = download_fits(timerange, imager)
    maps = load_fits(files)





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

 .. code-block:: none

    Results from 1 Provider:

    10 Results from the VSOClient:
    Source: https://sdac.virtualsolar.org/cgi/search
    Data retrieval status: https://docs.virtualsolar.org/wiki/VSOHealthReport
    Total estimated size: 21.084 Mbyte

           Start Time               End Time        Source Instrument Provider  Physobs  Extent Type   Size 
                                                                                                      Mibyte
    ----------------------- ----------------------- ------ ---------- -------- --------- ----------- -------
    2021-10-28 15:36:06.000 2021-10-28 15:36:31.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 15:48:05.000 2021-10-28 15:48:31.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 16:00:05.000 2021-10-28 16:00:30.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 16:12:05.000 2021-10-28 16:12:30.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 16:24:06.000 2021-10-28 16:24:31.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 16:36:05.000 2021-10-28 16:36:30.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 16:48:05.000 2021-10-28 16:48:30.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 17:00:05.000 2021-10-28 17:00:30.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 17:12:06.000 2021-10-28 17:12:31.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074
    2021-10-28 17:24:05.000 2021-10-28 17:24:30.000   SOHO      LASCO     SDAC intensity      CORONA 2.01074



    Files Downloaded:   0%|          | 0/10 [00:00<?, ?file/s]
    Files Downloaded:  10%|█         | 1/10 [00:00<00:01,  8.87file/s]
    Files Downloaded: 100%|██████████| 10/10 [00:00<00:00, 74.44file/s]




.. GENERATED FROM PYTHON SOURCE LINES 40-41

Process the downloaded fits files using the ``single_imager_maps_process`` utility. We select to process the maps into running differences images.

.. GENERATED FROM PYTHON SOURCE LINES 41-47

.. code-block:: Python


    processed_images = single_imager_maps_process(maps,
                                                  **selected_imagers.imager_dict[imager]['process'],
                                                  image_mode='Running Diff.',
                                                  diff_num=1)





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

 .. code-block:: none

    Preparing image sequence for C2. This could take a while...
    INFO: Obtained JPL HORIZONS location for SOHO (spacecraft) (-21)         [sunpy.coordinates.ephemeris]




.. GENERATED FROM PYTHON SOURCE LINES 48-49

Import the sample JSON fitting file using ``json_fitting_file_sample_data.fetch()`` method. This sample data contains a series of fitted ellipsoids for a selected event.

.. GENERATED FROM PYTHON SOURCE LINES 49-52

.. code-block:: Python


    json_fitting_file = json_fitting_file_sample_data.fetch('FLX1p0D20211028T153500MEllipsoid.json')








.. GENERATED FROM PYTHON SOURCE LINES 53-54

The ``model_fittings.load_from_json(json_fitting_file)`` loads the model fittings from the JSON file. The result is stored in the variable model_fittings_class.

.. GENERATED FROM PYTHON SOURCE LINES 54-57

.. code-block:: Python


    model_fittings_class = model_fittings.load_from_json(json_fitting_file)








.. GENERATED FROM PYTHON SOURCE LINES 58-59

Select the second fitting that corresponds to the first image on the list of maps sequence.

.. GENERATED FROM PYTHON SOURCE LINES 59-62

.. code-block:: Python


    model_parameters = model_fittings_class.parameters.iloc[1]








.. GENERATED FROM PYTHON SOURCE LINES 63-64

Construct the ellipsoid model. Define first the center of the ellipsoid and then use the ``ellipsoid`` class to make the model

.. GENERATED FROM PYTHON SOURCE LINES 64-78

.. code-block:: Python

    obstime = model_parameters.name

    center = SkyCoord(model_parameters['hgln']*u.degree,
                      model_parameters['hglt']*u.degree,
                      model_parameters['rcenter']*u.R_sun,
                      obstime=obstime, observer='earth',
                      frame=frames.HeliographicStonyhurst)

    model_shock = ellipsoid(center,
                            model_parameters['radaxis']*u.R_sun,
                            model_parameters['orthoaxis1']*u.R_sun,
                            model_parameters['orthoaxis2']*u.R_sun,
                            model_parameters['tilt']*u.degree)








.. GENERATED FROM PYTHON SOURCE LINES 79-80

Plot the first image using the ``make_figure`` utility and over-plot at the same axis the ellipsoid model.

.. GENERATED FROM PYTHON SOURCE LINES 80-85

.. code-block:: Python


    fig, ax = make_figure(processed_images[0], cmap='Greys_r', clim=[-20, 20], clip_model=True)
    model_shock.plot(ax, mode='Full')

    plt.show()



.. image-sg:: /_examples/Basic_Plots/images/sphx_glr_plot_ellipsod_on_image_001.png
   :alt: LASCO-C2 Orange white-light  $T_{AGV}:$2021-10-28 15:48:18
   :srcset: /_examples/Basic_Plots/images/sphx_glr_plot_ellipsod_on_image_001.png
   :class: sphx-glr-single-img


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

 .. code-block:: none

    INFO: Missing metadata for solar radius: assuming the standard radius of the photosphere. [sunpy.map.mapbase]
    INFO: Missing metadata for solar radius: assuming the standard radius of the photosphere. [sunpy.map.mapbase]
    INFO: Missing metadata for solar radius: assuming the standard radius of the photosphere. [sunpy.map.mapbase]
    LASCO
    LASCO-C2 Orange white-light 2021-10-28 15:48:05





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

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


.. _sphx_glr_download__examples_Basic_Plots_plot_ellipsod_on_image.py:

.. only:: html

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

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

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

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

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

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_ellipsod_on_image.zip <plot_ellipsod_on_image.zip>`


.. only:: html

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

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