pyValEIA.utils.coords
=====================

.. py:module:: pyValEIA.utils.coords

.. autoapi-nested-parse::

   Utilities for different coordinate systems.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   pyValEIA.utils.coords.longitude_to_local_time
   pyValEIA.utils.coords.compute_magnetic_coords
   pyValEIA.utils.coords.earth_radius


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

.. py:function:: longitude_to_local_time(longitude, utc_time)

   
   Convert geographic/geodetic longiutde to solar local time.


   :Parameters:

       **longitude** : array-like
           longitudes

       **utc_time** : array-like
           Array of timestamps in UT



   :Returns:

       **local_times** : array-like
           Solar local times array as datetime objects











   ..
       !! processed by numpydoc !!

.. py:function:: compute_magnetic_coords(lat, lon, epoch_time, mag_type='qd')

   
   Calculate magnetic coordinates from geodetic coordinates.


   :Parameters:

       **lat** : array-like
           Latitudes in degrees North

       **lon** : array-like
           Longitudes in degrees East

       **epoch_time** : dt.datetime
           Universal time for IGRF coefficients

       **mag_type** : str
           Magnetic coordinate type (default='qd')



   :Returns:

       **mlat** : array-like
           Magnetic latitude in degrees

       **mlon** : array-like
           Magnetic longitude in degrees







   .. seealso::

       
       :obj:`apexpy.Apex.convert`
           ..
       
   .. rubric:: Notes

   `mag_type` inputs are defined in `apexpy`.



   ..
       !! processed by numpydoc !!

.. py:function:: earth_radius(lat, Re=6378137, Rp=6356752)

   
   Calculate Earth's radius in meters at given latitudes.


   :Parameters:

       **lat** : array-like
           latitude array

       **Re** : float
           Radius of Earth's equator in meters (default=6378137)

       **Rp** : float
           Radius of Earth's poles in meters (default=6356752)



   :Returns:

       **Rearth** : array-like
           Earth's radius in meters at given latitudes











   ..
       !! processed by numpydoc !!