boinor.spheroid_location
========================

.. py:module:: boinor.spheroid_location

.. autoapi-nested-parse::

   Handling a ground station on an oblate ellipsoid.



Classes
-------

.. autoapisummary::

   boinor.spheroid_location.SpheroidLocation


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

.. py:class:: SpheroidLocation(lon, lat, h, body)

   Class representing a ground station on an oblate ellipsoid.


   .. py:property:: cartesian_cords

      Convert to the Cartesian Coordinate system.


   .. py:property:: f

      Get first flattening.


   .. py:property:: N

      Normal vector of the ellipsoid at the given location.


   .. py:property:: tangential_vecs

      Returns orthonormal vectors tangential to the ellipsoid at the given location.


   .. py:property:: radius_of_curvature

      Radius of curvature of the meridian at the latitude of the given location.


   .. py:method:: distance(px, py, pz)

      Calculates the distance from an arbitrary point to the given location (Cartesian coordinates).

      :param px: x-coordinate of the point
      :type px: ~astropy.units.quantity.Quantity
      :param py: y-coordinate of the point
      :type py: ~astropy.units.quantity.Quantity
      :param pz: z-coordinate of the point
      :type pz: ~astropy.units.quantity.Quantity



   .. py:method:: is_visible(px, py, pz)

      Determines whether an object located at a given point is visible from the given location.
      Returns true if true, false otherwise.

      :param px: x-coordinate of the point
      :type px: ~astropy.units.quantity.Quantity
      :param py: y-coordinate of the point
      :type py: ~astropy.units.quantity.Quantity
      :param pz: z-coordinate of the point
      :type pz: ~astropy.units.quantity.Quantity



   .. py:method:: cartesian_to_ellipsoidal(x, y, z)

      Converts cartesian coordinates to ellipsoidal coordinates for this ellipsoid.

      :param x: x-coordinate
      :type x: ~astropy.units.quantity.Quantity
      :param y: y-coordinate
      :type y: ~astropy.units.quantity.Quantity
      :param z: z-coordinate
      :type z: ~astropy.units.quantity.Quantity