astrohack.utils.tools
=====================

.. py:module:: astrohack.utils.tools


Functions
---------

.. autoapisummary::

   astrohack.utils.tools.get_valid_state_ids
   astrohack.utils.tools.get_telescope_lat_lon_rad
   astrohack.utils.tools.get_str_idx_in_list
   astrohack.utils.tools.raise_type_error
   astrohack.utils.tools.check_is_proper_type
   astrohack.utils.tools.check_is_proper_array
   astrohack.utils.tools.check_is_proper_shape


Module Contents
---------------

.. py:function:: get_valid_state_ids(obs_modes, desired_intent='MAP_ANTENNA_SURFACE', excluded_intents=('REFERENCE', 'SYSTEM_CONFIGURATION'))

   Get scan and subscan IDs
   SDM Tables Short Description (https://drive.google.com/file/d/16a3g0GQxgcO7N_ZabfdtexQ8r2jRbYIS/view)
   2.54 ScanIntent (p. 150)
   MAP ANTENNA SURFACE : Holography calibration scan

   2.61 SubscanIntent (p. 152)
   MIXED : Pointing measurement, some antennas are on-source, some off-source
   REFERENCE : reference measurement (used for boresight in holography).
   SYSTEM_CONFIGURATION: dummy scans at the begininng of each row at the VLA.
   Undefined : ?


.. py:function:: get_telescope_lat_lon_rad(telescope)

   Return array center's latitude, longitude and distance to the center of the earth based on the coordinate reference
   :param telescope: Telescope object

   Returns:
   Array center  latitude, longitude and distance to the center of the Earth in meters


.. py:function:: get_str_idx_in_list(target, array)

.. py:function:: raise_type_error(var_name, class_name)

.. py:function:: check_is_proper_type(var, class_ref)

.. py:function:: check_is_proper_array(array, ndim=None)

.. py:function:: check_is_proper_shape(array, shape)