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

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

.. _sphx_glr_generated_gallery_calculate_response_function.py:


========================================
Computing Wavelength Response Functions
========================================

This example shows how to compute the
wavelength response function of the 335 Å channel as
well as explore the different properties of the
telescope channels.


.. code-block:: default

    import matplotlib.pyplot as plt
    import astropy.units as u
    import astropy.time

    from aiapy.response import Channel









Since AIA uses wide-band filters, other wavelengths (outside of the nominal
wavelength attributed to each filter) contribute to the image data.
Computing these response functions allow us to see which other wavelengths
contribute to the image data.

First, create a channel object by specifying the
wavelength of the channel. In this case, we'll
choose the 335 Å channel, but this same workflow
can be applied to any of the EUV or UV channels
on AIA. This may take a few seconds the first time you do
this as the most recent instrument data file will
need to be downloaded from a remote server. Subsequent
calls will know that the data has been downloaded.


.. code-block:: default

    c = Channel(335*u.angstrom)








From `Boerner et al. (2012) <https://doi.org/10.1007/s11207-011-9804-8>`_,
the wavelength response function is given by,

.. math::
  R(\lambda) = A_{geo}R_P(\lambda)R_S(\lambda)T_E(\lambda)T_F(\lambda)
  D(\lambda)Q(\lambda)G(\lambda),

where

- :math:`A_{geo}` geometrical collecting area
- :math:`R_P,R_S` reflectances of primary and secondary mirrors, respectively
- :math:`T_E, T_F` transmission efficiency of the entrance and focal-plane
  filters, respectively
- :math:`D` contaminant transmittance of optics
- :math:`Q` quantum efficiency of the CCD
- :math:`G` gain of the CCD camera system

The `~aiapy.response.Channel` object provides an interface to all of these
properties of the telescope. Below, we show how to plot several of these
properties as a function of wavelength.


.. code-block:: default

    fig = plt.figure()
    ax = fig.add_subplot(221)
    ax.plot(c.wavelength, c.primary_reflectance, label=r'$R_P$')
    ax.plot(c.wavelength, c.secondary_reflectance, label=r'$R_S$')
    ax.set_ylabel(r'Reflectance')
    ax.set_xlim(50, 400)
    ax.set_xlabel(r'$\lambda$ [Å]')
    ax.legend(frameon=False)
    ax = fig.add_subplot(222)
    ax.plot(c.wavelength, c.entrance_filter_efficiency, label=r'$T_E$')
    ax.plot(c.wavelength, c.focal_plane_filter_efficiency, label=r'$T_F$')
    ax.set_ylabel(r'Transmittance')
    ax.set_xlim(50, 400)
    ax.set_xlabel(r'$\lambda$ [Å]')
    ax.legend(frameon=False)
    ax = fig.add_subplot(223)
    ax.plot(c.wavelength, c.contamination)
    ax.set_ylabel(r'Contamination, $D(\lambda)$')
    ax.set_xlim(50, 400)
    ax.set_xlabel(r'$\lambda$ [Å]')
    ax = fig.add_subplot(224)
    ax.plot(c.wavelength, c.quantum_efficiency)
    ax.set_ylabel(r'Quantum Efficiency, $Q(\lambda)$')
    ax.set_xlim(50, 800)
    ax.set_xlabel(r'$\lambda$ [Å]')
    plt.tight_layout()




.. image:: /generated/gallery/images/sphx_glr_calculate_response_function_001.png
    :class: sphx-glr-single-img





Additionally, `~aiapy.response.Channel` provides a method for calculating
the wavelength response function using the equation above,


.. code-block:: default

    r = c.wavelength_response()
    print(r)





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

 Out:

 .. code-block:: none

    [1.6854788e-08 1.6595683e-08 1.6341122e-08 ... 2.5859875e-11 2.5686821e-11
     2.5515087e-11] cm2 ct / ph




We can then plot the response as a function of
wavelength.


.. code-block:: default

    fig = plt.figure()
    ax = fig.gca()
    ax.plot(c.wavelength, r)
    ax.set_xlim((c.channel + [-10, 10]*u.angstrom).value)
    ax.set_ylim(0, 0.03)
    ax.set_xlabel(r'$\lambda$ [Å]')
    ax.set_ylabel(f'$R(\lambda)$ [{r.unit.to_string("latex")}]')




.. image:: /generated/gallery/images/sphx_glr_calculate_response_function_002.png
    :class: sphx-glr-single-img


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

 Out:

 .. code-block:: none


    Text(0, 0.5, '$R(\\lambda)$ [$\\mathrm{\\frac{cm^{2}\\,ct}{ph}}$]')



On telescopes 1, 3, and 4, both channels are always illuminated.
This can lead to "crosstalk" contamination in a channel from the channel with
which it shares a telescope. This impacts the 94 Å and 304 Å channels
as well as the 131 Å and 335 Å channels. This effect is included
by default in the wavelength response calculation. To exclude this
effect,


.. code-block:: default

    r_no_cross = c.wavelength_response(include_crosstalk=False)








If we look at the response around 131 Å (the channel with which 335 Å shares
a telescope), we can see the effect that the channel crosstalk has on the
335 Å response function.


.. code-block:: default

    fig = plt.figure()
    ax = fig.gca()
    ax.plot(c.wavelength, r, label='crosstalk')
    ax.plot(c.wavelength, r_no_cross, label='no crosstalk')
    ax.set_xlim(50, 350)
    ax.set_xlabel(r'$\lambda$ [Å]')
    ax.set_ylabel(f'$R(\lambda)$ [{r.unit.to_string("latex")}]')
    ax.legend(loc=1, frameon=False)




.. image:: /generated/gallery/images/sphx_glr_calculate_response_function_003.png
    :class: sphx-glr-single-img


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

 Out:

 .. code-block:: none


    <matplotlib.legend.Legend object at 0x128ae2880>



We can also incorporate various corrections to the
response functions, including a time-dependent
degradation correction as well as a correction based
on the EVE calibration. The latter also includes the
time-dependent correction. As an example, to apply the
two aforementioned corrections given the degradation as
of 1 January 2019,


.. code-block:: default

    obstime = astropy.time.Time('2019-01-01T00:00:00')
    r_time = c.wavelength_response(obstime=obstime)
    r_eve = c.wavelength_response(obstime=obstime, include_eve_correction=True)





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

 Out:

 .. code-block:: none

    /Users/willbarnes/anaconda/envs/aiapy-dev/lib/python3.8/site-packages/astropy/_erfa/core.py:104: ErfaWarning: ERFA function "taiutc" yielded 1 of "dubious year (Note 4)"
      warnings.warn('ERFA function "' + func_name + '" yielded ' + wmsg, ErfaWarning)
    /Users/willbarnes/anaconda/envs/aiapy-dev/lib/python3.8/site-packages/astropy/_erfa/core.py:104: ErfaWarning: ERFA function "utctai" yielded 1 of "dubious year (Note 3)"
      warnings.warn('ERFA function "' + func_name + '" yielded ' + wmsg, ErfaWarning)
    /Users/willbarnes/anaconda/envs/aiapy-dev/lib/python3.8/site-packages/astropy/_erfa/core.py:104: ErfaWarning: ERFA function "dtf2d" yielded 82 of "dubious year (Note 6)"
      warnings.warn('ERFA function "' + func_name + '" yielded ' + wmsg, ErfaWarning)




We can then compare the two corrected response
functions to the uncorrected case.


.. code-block:: default

    fig = plt.figure()
    ax = fig.gca()
    ax.plot(c.wavelength, r, label='uncorrected')
    ax.plot(c.wavelength, r_time, label='degradation correction')
    ax.plot(c.wavelength, r_eve, label='EVE correction')
    ax.set_xlim((c.channel + [-20, 20]*u.angstrom).value)
    ax.set_ylim(0, 0.03)
    ax.set_xlabel(r'$\lambda$ [Å]')
    ax.set_ylabel(f'$R(\lambda)$ [{r.unit.to_string("latex")}]')
    ax.legend(loc=2, frameon=False)



.. image:: /generated/gallery/images/sphx_glr_calculate_response_function_004.png
    :class: sphx-glr-single-img


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

 Out:

 .. code-block:: none


    <matplotlib.legend.Legend object at 0x128a987c0>




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

   **Total running time of the script:** ( 1 minutes  9.635 seconds)


.. _sphx_glr_download_generated_gallery_calculate_response_function.py:


.. only :: html

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



  .. container:: sphx-glr-download

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



  .. container:: sphx-glr-download

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


.. only:: html

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

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