orca.utils.coordutils
=====================

.. py:module:: orca.utils.coordutils

.. autoapi-nested-parse::

   Coordinate utilities for OVRO-LWA observations.

   Provides functions for coordinate transformations between celestial and
   local horizontal coordinate systems, visibility calculations accounting
   for horizon and mountain obstructions, and sky position utilities.

   For image plane pixel coordinates, use FITS headers with astropy.WCS.



Attributes
----------

.. autoapisummary::

   orca.utils.coordutils.OVRO_LWA_LOCATION
   orca.utils.coordutils.CAS_A
   orca.utils.coordutils.CYG_A
   orca.utils.coordutils.TAU_A
   orca.utils.coordutils.TAU_BOO
   orca.utils.coordutils.MOUNTAIN_AZ_INC


Functions
---------

.. autoapisummary::

   orca.utils.coordutils.sun_icrs
   orca.utils.coordutils.is_visible
   orca.utils.coordutils.get_altaz_at_ovro
   orca.utils.coordutils.zenith_coord_at_ovro


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

.. py:data:: OVRO_LWA_LOCATION

.. py:data:: CAS_A

.. py:data:: CYG_A

.. py:data:: TAU_A

.. py:data:: TAU_BOO

.. py:data:: MOUNTAIN_AZ_INC

.. py:function:: sun_icrs(utc_time: datetime.datetime) -> astropy.coordinates.SkyCoord

.. py:function:: is_visible(coordinates: Union[astropy.coordinates.SkyCoord, astropy.coordinates.ICRS], utc_time: datetime.datetime, altitude_limit: astropy.units.Quantity = 5 * u.degree, check_mountain: bool = True) -> bool

   Check if a source with coord is altitude_limit (default to 5 deg) above the horizon (and optionally the mountains)

   :param coordinates: coordinates of the object to check for visibility
   :param utc_time: utc timestamp for the time of observation
   :param altitude_limit: altitude limit above the horizon/mountain top
   :param check_mountain: determines whether to take the altitude of the mountain into account

   Returns: whether the coordinate is visible



.. py:function:: get_altaz_at_ovro(coordinates: astropy.coordinates.SkyCoord, utc_time: datetime.datetime) -> astropy.coordinates.SkyCoord

   Get the AltAz coordinates at OVRO.

   :param coordinates: coordinates.
   :param utc_time: time of observation.

   Returns: SkyCoord that is in AltAz.



.. py:function:: zenith_coord_at_ovro(utc_time: datetime.datetime) -> astropy.coordinates.SkyCoord

   Get the zenith coordinates at OVRO.

   :param utc_time: time of observation.

   Returns: SkyCoord in ICRS.