:py:mod:`km3astro.frame`
========================

.. py:module:: km3astro.frame


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

Classes
~~~~~~~

.. autoapisummary::

   km3astro.frame.ParticleFrame
   km3astro.frame.UTM



Functions
~~~~~~~~~

.. autoapisummary::

   km3astro.frame.get_location
   km3astro.frame.convergence_angle
   km3astro.frame.utm_zone
   km3astro.frame.longitude_of_central_meridian
   km3astro.frame.ParticleFrame_to_AltAz
   km3astro.frame.AltAz_to_ParticleFrame
   km3astro.frame.UTM_to_AltAz
   km3astro.frame.AltAz_to_UTM
   km3astro.frame.UTM_to_ParticleFrame
   km3astro.frame.ParticleFrame_to_UTM



Attributes
~~~~~~~~~~

.. autoapisummary::

   km3astro.frame.LOCATIONS


.. py:data:: LOCATIONS

   

.. py:function:: get_location(location)


.. py:function:: convergence_angle(lat, lon)

   
   Calculate the converge angle on the UTM grid.


   :Parameters:

       **lon** : number
           Longitude in rad

       **lat** : number
           Latitude in rad














   ..
       !! processed by numpydoc !!

.. py:function:: utm_zone(lat)

   
   The UTM zone for a given latitude


   :Parameters:

       **lat** : number
           Latitude in rad














   ..
       !! processed by numpydoc !!

.. py:function:: longitude_of_central_meridian(utmzone)

   
   The longitude of the central meridian for a given UTM zone.


   :Parameters:

       **utmzone** : number
           The UTM zone.














   ..
       !! processed by numpydoc !!

.. py:class:: ParticleFrame(*args, copy=True, representation_type=None, differential_type=None, **kwargs)




   
   The base class for coordinate frames.

   This class is intended to be subclassed to create instances of specific
   systems.  Subclasses can implement the following attributes:

   * `default_representation`
       A subclass of `~astropy.coordinates.BaseRepresentation` that will be
       treated as the default representation of this frame.  This is the
       representation assumed by default when the frame is created.

   * `default_differential`
       A subclass of `~astropy.coordinates.BaseDifferential` that will be
       treated as the default differential class of this frame.  This is the
       differential class assumed by default when the frame is created.

   * `~astropy.coordinates.Attribute` class attributes
      Frame attributes such as ``FK4.equinox`` or ``FK4.obstime`` are defined
      using a descriptor class.  See the narrative documentation or
      built-in classes code for details.

   * `frame_specific_representation_info`
       A dictionary mapping the name or class of a representation to a list of
       `~astropy.coordinates.RepresentationMapping` objects that tell what
       names and default units should be used on this frame for the components
       of that representation.

   Unless overridden via `frame_specific_representation_info`, velocity name
   defaults are:

     * ``pm_{lon}_cos{lat}``, ``pm_{lat}`` for `SphericalCosLatDifferential`
       proper motion components
     * ``pm_{lon}``, ``pm_{lat}`` for `SphericalDifferential` proper motion
       components
     * ``radial_velocity`` for any ``d_distance`` component
     * ``v_{x,y,z}`` for `CartesianDifferential` velocity components

   where ``{lon}`` and ``{lat}`` are the frame names of the angular components.















   ..
       !! processed by numpydoc !!
   .. py:attribute:: default_representation

      

   .. py:attribute:: obstime

      

   .. py:attribute:: location

      


.. py:class:: UTM(*args, copy=True, representation_type=None, differential_type=None, **kwargs)




   
   The base class for coordinate frames.

   This class is intended to be subclassed to create instances of specific
   systems.  Subclasses can implement the following attributes:

   * `default_representation`
       A subclass of `~astropy.coordinates.BaseRepresentation` that will be
       treated as the default representation of this frame.  This is the
       representation assumed by default when the frame is created.

   * `default_differential`
       A subclass of `~astropy.coordinates.BaseDifferential` that will be
       treated as the default differential class of this frame.  This is the
       differential class assumed by default when the frame is created.

   * `~astropy.coordinates.Attribute` class attributes
      Frame attributes such as ``FK4.equinox`` or ``FK4.obstime`` are defined
      using a descriptor class.  See the narrative documentation or
      built-in classes code for details.

   * `frame_specific_representation_info`
       A dictionary mapping the name or class of a representation to a list of
       `~astropy.coordinates.RepresentationMapping` objects that tell what
       names and default units should be used on this frame for the components
       of that representation.

   Unless overridden via `frame_specific_representation_info`, velocity name
   defaults are:

     * ``pm_{lon}_cos{lat}``, ``pm_{lat}`` for `SphericalCosLatDifferential`
       proper motion components
     * ``pm_{lon}``, ``pm_{lat}`` for `SphericalDifferential` proper motion
       components
     * ``radial_velocity`` for any ``d_distance`` component
     * ``v_{x,y,z}`` for `CartesianDifferential` velocity components

   where ``{lon}`` and ``{lat}`` are the frame names of the angular components.















   ..
       !! processed by numpydoc !!
   .. py:property:: alt_utm

      
      Altitude in UTM
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: default_representation

      

   .. py:attribute:: frame_specific_representation_info

      

   .. py:attribute:: obstime

      

   .. py:attribute:: location

      


.. py:function:: ParticleFrame_to_AltAz(ParticleFrame_, altaz)


.. py:function:: AltAz_to_ParticleFrame(altaz_, particleframe_)


.. py:function:: UTM_to_AltAz(UTM_, altaz)


.. py:function:: AltAz_to_UTM(altaz_, UTM_)


.. py:function:: UTM_to_ParticleFrame(UTM_, particleframe)


.. py:function:: ParticleFrame_to_UTM(particleframe, UTM_)