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

.. py:module:: boinor.frames.util

.. autoapi-nested-parse::

   module with utility functions for the frames sub-package



Functions
---------

.. autoapisummary::

   boinor.frames.util.get_frame


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

.. py:function:: get_frame(attractor, plane, obstime=J2000)

   Returns an appropriate reference frame from an attractor and a plane.

   Available planes are Earth equator (parallel to GCRS) and Earth ecliptic.
   The fundamental direction of both is the equinox of epoch (J2000).
   An obstime is needed to properly locate the attractor.

   :param attractor: Body that serves as the center of the frame.
   :type attractor: ~boinor.bodies.Body
   :param plane: Fundamental plane of the frame.
   :type plane: ~boinor.frames.Planes
   :param obstime: Time of the frame.
   :type obstime: ~astropy.time.Time