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

.. only:: html

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

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

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

.. _sphx_glr_auto_examples_plot_telescope_arfs_rmfs_srms.py:


Telescope ARFs, RMFs, and SRMs
==============================

Throughout the `modules in the codebase <https://foxsi.github.io/response-tools/modules.html>`__ 
there are a variety of functions with names starting wtih ``asset``. 
These functions were created to mainly test the functions being written
but they might be useful to see and compare a lot of the response 
elements.

One such example is an ``asset`` function that generates a plot showing 
all of FOXSI-4's telescope ARFs, RMFs, and SRMs in one plot.

.. GENERATED FROM PYTHON SOURCE LINES 14-17

.. code-block:: Python


    import response_tools.responses as responses








.. GENERATED FROM PYTHON SOURCE LINES 18-21

Some caveats come with these asset functions as many choices that the
user can make are obviously chosen then hidden in the function but it
might still be useful to see an idea of what these elements look like:

.. GENERATED FROM PYTHON SOURCE LINES 21-24

.. code-block:: Python


    responses.asset_response_chain_plot()




.. image-sg:: /auto_examples/images/sphx_glr_plot_telescope_arfs_rmfs_srms_001.png
   :alt: Pos. 0: ARF, Pos. 0: RMF, Pos. 0: SRM, Pos. 1: ARF, Pos. 1: RMF, Pos. 1: SRM, Pos. 2: ARF, Pos. 2: RMF, Pos. 2: SRM, Pos. 3: ARF, Pos. 3: RMF, Pos. 3: SRM, Pos. 4: ARF, Pos. 4: RMF, Pos. 4: SRM, Pos. 5: ARF, Pos. 5: RMF, Pos. 5: SRM, Pos. 6: ARF
   :srcset: /auto_examples/images/sphx_glr_plot_telescope_arfs_rmfs_srms_001.png
   :class: sphx-glr-single-img


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

 .. code-block:: none

    WARNING:root:The `off_axis_angle` input for Position 0's optics (foxsi4_position0_optics) is not yet implemented.
    WARNING:root:The `off_axis_angle` input for MSFC high-resolution optics (eff_area_msfc_hi_res) is not yet implemented.
    WARNING:root:In foxsi4_telescope_spectral_response, the "telescope" fields from `arf_response` (foxsi4-telescope0) and `rmf_response` (foxsi4-telescope1) do not match.
    An output shall be produced if possible (check the returned objects"telescope" field) but the user should be cautious.
    WARNING:root:The `off_axis_angle` input for Position 1's optics (foxsi4_position1_optics) is not yet implemented.
    WARNING:root:The `off_axis_angle` input for Nagoya high-resolution optics (eff_area_nagoya_sxt) is not yet implemented.
    WARNING:root:The `off_axis_angle` input for Telescope 3's optics (foxsi4_telescope3_arf) is not yet implemented.
    WARNING:root:The `off_axis_angle` input for Telescope 4's optics (foxsi4_telescope4_arf) is not yet implemented.
    WARNING:root:The Telescope 6 Timepix detector response from foxsi4_telescope6_rmf does not yet exist.
    WARNING:root:The Position 6 Timepix detector response from foxsi4_position6_detector_response does not yet exist.
    WARNING:root:The `off_axis_angle` input for Position 3's optics (foxsi4_position6_optics) is not yet implemented.
    WARNING:root:The `off_axis_angle` input for MSFC high-resolution optics (eff_area_msfc_hi_res) is not yet implemented.




.. GENERATED FROM PYTHON SOURCE LINES 25-35

**Note** these functions are not usually names the best since they 
were originally for testing purposes and so the names might change. 
Please utilize the `auto-generated code documentation <https://foxsi.github.io/response-tools/modules.html>`__
to keep up-to-date.

All figures produced using all of the ``asset`` functions can be found
in the codebase. The ``assets`` folder is on the same directory level 
as the ``response-information`` folder that can be found using the 
Python package global variable: ``response_tools.responseFilePath`` 
(more on the ``responseFilePath`` global variable 
`here <https://foxsi.github.io/response-tools/general_instructions.html#python-interface-to-pull-data>`__).


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

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


.. _sphx_glr_download_auto_examples_plot_telescope_arfs_rmfs_srms.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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