boinor.util
===========

.. py:module:: boinor.util

.. autoapi-nested-parse::

   Function helpers.



Functions
---------

.. autoapisummary::

   boinor.util.norm
   boinor.util.time_range
   boinor.util.find_closest_value
   boinor.util.alinspace
   boinor.util.wrap_angle


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

.. py:function:: norm(vec, axis=None)

   Norm of a Quantity vector that respects units.

   :param vec: Vector with units.
   :type vec: ~astropy.units.Quantity
   :param axis: Axis along which to compute the vector norms.
   :type axis: int or None


.. py:function:: time_range(start, *, num_values=50, spacing=None, end=None, format=None, scale=None)

   Generates range of astronomical times.

   .. versionadded:: 0.8.0

   :param start: Start time.
   :type start: ~astropy.time.Time or ~astropy.units.Quantity
   :param num_values: Number of equal spaced time values to be generated, default to 50.
   :type num_values: int, optional
   :param spacing: Spacing between periods, optional.
   :type spacing: ~astropy.time.Time or ~astropy.units.Quantity, optional
   :param end: End date.
   :type end: ~astropy.time.Time or equivalent, optional

   :returns: **result** -- Array of time values.
   :rtype: ~astropy.time.Time


.. py:function:: find_closest_value(value, values)

   Calculates the closest value in the given values.

   :param value: Reference value.
   :type value: ~astropy.units.Quantity
   :param values: Values to search from.
   :type values: ~astropy.units.Quantity


.. py:function:: alinspace(start, stop=None, *, num=50, endpoint=True)

   Return increasing, evenly spaced angular values over a specified interval.


.. py:function:: wrap_angle(angle, limit=180 * u.deg)

   Scale angle into interval from 0 to 180 degree.