boinor.core.events
==================

.. py:module:: boinor.core.events

.. autoapi-nested-parse::

   module containing functions related to events in the core sub-package



Functions
---------

.. autoapisummary::

   boinor.core.events.eclipse_function
   boinor.core.events.line_of_sight
   boinor.core.events.elevation_function


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

.. py:function:: eclipse_function(k, u_, r_sec, R_sec, R_primary, umbra=True)

   Calculates a continuous shadow function.

   :param k: Standard gravitational parameter (km^3 / s^2).
   :type k: float
   :param u_: Satellite position and velocity vector with respect to the primary body.
   :type u_: numpy.ndarray
   :param r_sec: Position vector of the secondary body with respect to the primary body.
   :type r_sec: numpy.ndarray
   :param R_sec: Equatorial radius of the secondary body.
   :type R_sec: float
   :param R_primary: Equatorial radius of the primary body.
   :type R_primary: float
   :param umbra: Whether to calculate the shadow function for umbra or penumbra, defaults to True
                 i.e. calculates for umbra.
   :type umbra: bool

   .. rubric:: Notes

   The shadow function is taken from Escobal, P. (1985). Methods of orbit determination.
   The current implementation assumes circular bodies and doesn't account for flattening.


.. py:function:: line_of_sight(r1, r2, R)

   Calculates the line of sight condition between two position vectors, r1 and r2.

   :param r1: The position vector of the first object with respect to a central attractor.
   :type r1: numpy.ndarray
   :param r2: The position vector of the second object with respect to a central attractor.
   :type r2: numpy.ndarray
   :param R: The radius of the central attractor.
   :type R: float

   :returns: **delta_theta** -- Greater than or equal to zero, if there exists a LOS between two objects
             located by r1 and r2, else negative.
   :rtype: float


.. py:function:: elevation_function(k, u_, phi, theta, R, R_p, H)

   Calculates the elevation angle of an object in orbit with respect to
   a location on attractor.

   :param k: Standard gravitational parameter.
   :type k: float
   :param u_: Satellite position and velocity vector with respect to the central attractor.
   :type u_: numpy.ndarray
   :param phi: Geodetic Latitude of the station.
   :type phi: float
   :param theta: Local sidereal time at a particular instant.
   :type theta: float
   :param R: Equatorial radius of the central attractor.
   :type R: float
   :param R_p: Polar radius of the central attractor.
   :type R_p: float
   :param H: Elevation, above the ellipsoidal surface.
   :type H: float