=====================
How to get IMA tables
=====================

Azimuth table
=============

Azimuthal angle tables for VEX/MEX IMA are obtained from functions
- :func:`irfpy.vima.fov.get_azimuth_angle`
- :func:`irfpy.mima.fov.get_azimuth_angle`

You can get the angles as follows.

>>> import irfpy.vima.fov
>>> print(irfpy.vima.fov.get_azimuth_angle(7))
-78.75


Elevation table
===============

Elevation angle values for VEX(/MEX) IMA are obtained from functions

- :func:`irfpy.vima.fov.get_elevation_geometric`
- :func:`irfpy.vima.fov.get_elevation_table`
- :func:`irfpy.mima.fov.get_elevation_geometric` (not implemented)
- :func:`irfpy.mima.fov.get_elevation_table` (not implemented)

.. todo::

        Corresponding functions of above functions to be implemented for MEX.
        Currently for MEX, only the ``object oriented version`` is available.
        - :class:`irfpy.mima.fov.SimpleFOV`
        - :class:`irfpy.mima.fov.TableFOV`


Direction as vector
===================

From azimuth and elevation angles, the unit vector of the instrument channel can be derived.
- :func:`irfpy.vima.fov.get_vector`
- :func:`irfpy.mima.fov.get_vector`
provide this functionality.

.. todo::

        The implementation of above functions.


Energy table
============

Energy tables for VEX/MEX IMA are obtained from functions in :mod:`irfpy.vima.energy` and :mod:`irfpy.mima.energy`.

- :func:`irfpy.vima.energy.get_default_table_v1` 
- :func:`irfpy.vima.energy.get_default_table_v3`

.. note::

        Different from the other table, these functions return the energy table as array.

.. todo::

        Make a function that returns the energy for the given index.

:func:`irfpy.vima.energy.get_default_table_v1` returns the energy table (96 element array) for the beginning phase
of the VEX/IMA operation.
Later, the energy table was changed to :func:`irfpy.vima.energy.get_default_table_v3`.

Similarly, for MEX/IMA, following functions returns the energy table as 96 element array.

- :func:`irfpy.mima.energy.get_default_table_v4` for the beginning of mission
- :func:`irfpy.mima.energy.get_default_table_v5` after the first patch
- :func:`irfpy.mima.energy.get_default_table_v5_late` after the second patch
- :func:`irfpy.mima.energy.get_default_table_v6` for the fast mode (24 s) table

The fast mode table has only 32 energy steps; If one wants 32-energy step array, one can use:

- :func:`irfpy.mima.energy.get_default_table_v6_squashed` for the fast mode (24 s) table as 32 element array

Mass table
==========

Mass value for VEX/MEX IMA are obtained from functions below.

- :func:`irfpy.vima.massring.rm`
- :func:`irfpy.mima.massring.rm`

These functions returns the mass index corresponding to the given energy and mass.

.. todo::

        Implement of the inverse functions, namely, the mass ring index to the physical mass.

To obtain the expected width of the mass response, use

- :func:`irfpy.vima.massring.dm`
- :func:`irfpy.mima.massring.dm`