boinor.twobody.states
=====================

.. py:module:: boinor.twobody.states


Classes
-------

.. autoapisummary::

   boinor.twobody.states.BaseState
   boinor.twobody.states.ClassicalState
   boinor.twobody.states.RVState
   boinor.twobody.states.ModifiedEquinoctialState


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

.. py:class:: BaseState(attractor, elements, plane)

   Base State class, meant to be subclassed.


   .. py:property:: plane

      Fundamental plane of the frame.


   .. py:property:: attractor

      Main attractor.


   .. py:property:: n

      Mean motion.


   .. py:property:: period

      Period of the orbit.


   .. py:property:: r_p

      Radius of pericenter.


   .. py:property:: r_a

      Radius of apocenter.


   .. py:property:: t_p

      Elapsed time since latest perifocal passage.


   .. py:method:: to_tuple()


   .. py:method:: to_value()
      :abstractmethod:


      Converts to raw values with appropriate units.



   .. py:method:: to_vectors()
      :abstractmethod:


      Converts to position and velocity vector representation.

      :rtype: RVState



   .. py:method:: to_classical()
      :abstractmethod:


      Converts to classical orbital elements representation.

      :rtype: ClassicalState



   .. py:method:: to_equinoctial()
      :abstractmethod:


      Converts to modified equinoctial elements representation.

      :rtype: ModifiedEquinoctialState



.. py:class:: ClassicalState(attractor, elements, plane)

   Bases: :py:obj:`BaseState`


   State defined by its classical orbital elements.

   Orbital elements:

   p : ~astropy.units.Quantity
       Semilatus rectum.
   ecc : ~astropy.units.Quantity
       Eccentricity.
   inc : ~astropy.units.Quantity
       Inclination.
   raan : ~astropy.units.Quantity
       Right ascension of the ascending node.
   argp : ~astropy.units.Quantity
       Argument of the perigee.
   nu : ~astropy.units.Quantity
       True anomaly.



   .. py:property:: p

      Semilatus rectum.


   .. py:property:: a

      Semimajor axis.


   .. py:property:: ecc

      Eccentricity.


   .. py:property:: inc

      Inclination.


   .. py:property:: raan

      Right ascension of the ascending node.


   .. py:property:: argp

      Argument of the perigee.


   .. py:property:: nu

      True anomaly.


   .. py:method:: to_value()

      Converts to raw values with appropriate units.



   .. py:method:: to_vectors()

      Converts to position and velocity vector representation.



   .. py:method:: to_classical()

      Converts to classical orbital elements representation.



   .. py:method:: to_equinoctial()

      Converts to modified equinoctial elements representation.



   .. py:property:: plane

      Fundamental plane of the frame.


   .. py:property:: attractor

      Main attractor.


   .. py:property:: n

      Mean motion.


   .. py:property:: period

      Period of the orbit.


   .. py:property:: r_p

      Radius of pericenter.


   .. py:property:: r_a

      Radius of apocenter.


   .. py:property:: t_p

      Elapsed time since latest perifocal passage.


   .. py:method:: to_tuple()


.. py:class:: RVState(attractor, elements, plane)

   Bases: :py:obj:`BaseState`


   State defined by its position and velocity vectors.

   Orbital elements:

   r : ~astropy.units.Quantity
       Position vector wrt attractor center.
   v : ~astropy.units.Quantity
       Velocity vector.



   .. py:property:: r

      Position vector.


   .. py:property:: v

      Velocity vector.


   .. py:method:: to_value()

      Converts to raw values with appropriate units.



   .. py:method:: to_vectors()

      Converts to position and velocity vector representation.



   .. py:method:: to_classical()

      Converts to classical orbital elements representation.



   .. py:property:: plane

      Fundamental plane of the frame.


   .. py:property:: attractor

      Main attractor.


   .. py:property:: n

      Mean motion.


   .. py:property:: period

      Period of the orbit.


   .. py:property:: r_p

      Radius of pericenter.


   .. py:property:: r_a

      Radius of apocenter.


   .. py:property:: t_p

      Elapsed time since latest perifocal passage.


   .. py:method:: to_tuple()


   .. py:method:: to_equinoctial()
      :abstractmethod:


      Converts to modified equinoctial elements representation.

      :rtype: ModifiedEquinoctialState



.. py:class:: ModifiedEquinoctialState(attractor, elements, plane)

   Bases: :py:obj:`BaseState`


   State defined by modified equinoctial elements representation.

   Orbital elements:

   p : ~astropy.units.Quantity
       Semilatus rectum.
   f : ~astropy.units.Quantity
       Second modified equinoctial element.
   g : ~astropy.units.Quantity
       Third modified equinoctial element.
   h : ~astropy.units.Quantity
       Fourth modified equinoctial element.
   k : ~astropy.units.Quantity
       Fifth modified equinoctial element.
   L : ~astropy.units.Quantity
       True longitude.



   .. py:property:: p

      Semilatus rectum.


   .. py:property:: f

      Second modified equinoctial element.


   .. py:property:: g

      Third modified equinoctial element.


   .. py:property:: h

      Fourth modified equinoctial element.


   .. py:property:: k

      Fifth modified equinoctial element.


   .. py:property:: L

      True longitude.


   .. py:method:: to_value()

      Converts to raw values with appropriate units.



   .. py:method:: to_classical()

      Converts to classical orbital elements representation.



   .. py:method:: to_vectors()

      Converts to position and velocity vector representation.



   .. py:property:: plane

      Fundamental plane of the frame.


   .. py:property:: attractor

      Main attractor.


   .. py:property:: n

      Mean motion.


   .. py:property:: period

      Period of the orbit.


   .. py:property:: r_p

      Radius of pericenter.


   .. py:property:: r_a

      Radius of apocenter.


   .. py:property:: t_p

      Elapsed time since latest perifocal passage.


   .. py:method:: to_tuple()


   .. py:method:: to_equinoctial()
      :abstractmethod:


      Converts to modified equinoctial elements representation.

      :rtype: ModifiedEquinoctialState