boinor.sensors
==============

.. py:module:: boinor.sensors

.. autoapi-nested-parse::

   module containing functions related to sensors



Functions
---------

.. autoapisummary::

   boinor.sensors.min_and_max_ground_range
   boinor.sensors.ground_range_diff_at_azimuth


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

.. py:function:: min_and_max_ground_range(altitude, fov, boresight, R)

   Calculate the minimum and maximum values of ground-range angles.

   :param altitude: Altitude over surface.
   :type altitude: ~astropy.units.Quantity
   :param fov: Angle of the total area that a sensor can observe.
   :type fov: ~astropy.units.Quantity
   :param boresight: Center boresight angle.
   :type boresight: ~astropy.units.Quantity
   :param R: Attractor equatorial radius.
   :type R: ~astropy.units.Quantity

   :returns: * **lat_lon_min** (*~astropy.units.Quantity*) -- Minimum value of latitude and longitude.
             * **lat_lon_max** (*~astropy.units.Quantity*) -- Maximum value of latitude and longitude.


.. py:function:: ground_range_diff_at_azimuth(altitude, fov, boresight, azimuth, nadir_lat, nadir_lon, R)

   Calculate the difference in ground-range angles.

   Use the boresight angle, the latitude and longitude of the target,
   and the desired azimuth (which directs where the sensor is looking).

   :param altitude: Altitude over surface.
   :type altitude: ~astropy.units.Quantity
   :param fov: Angle of the total area that a sensor can observe.
   :type fov: ~astropy.units.Quantity
   :param boresight: Center boresight angle.
   :type boresight: ~astropy.units.Quantity
   :param azimuth: Azimuth angle, used to specify where the sensor is looking.
   :type azimuth: ~astropy.units.Quantity
   :param nadir_lat: Latitude angle of nadir point.
   :type nadir_lat: ~astropy.units.Quantity
   :param nadir_lon: Longitude angle of nadir point.
   :type nadir_lon: ~astropy.units.Quantity
   :param R: Attractor equatorial radius.
   :type R: ~astropy.units.Quantity

   :returns: * **ground_range_diff** (*~astropy.units.Quantity*) -- The difference in ground-range angles from the boresight angle.
             * **target_lat** (*~astropy.units.Quantity*) -- Latitude angle of the target point.
             * **target_lon** (*~astropy.units.Quantity*) -- Longitude angle of the target point.

   :raises ValueError: This formula always gives the answer for the short way to the target of the acute azimuth angle,
       which must be greater or equal than 0º and less than 180º.