:py:mod:`pytmosph3r.planetary_system.orbit.base`
================================================

.. py:module:: pytmosph3r.planetary_system.orbit.base


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

.. py:class:: Orbit


   Bases: :py:obj:`abc.ABC`, :py:obj:`pytmosph3r.log.Logger`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:property:: is_tidal_locked
      :type: bool


   .. py:method:: r(true_anomaly: float = 0) -> float
      :abstractmethod:

      Returns the distance between the star and the planet in `m`.

      :param true_anomaly (): True anomaly in radian.


   .. py:method:: star_coordinates_projected(phase)
      :abstractmethod:

      Returns the coordinates in the reference frame of the transmittance (as seen from the observer).
      Only used in transmission, lightcurve.

      Should return (rayon, angle) (polar coordinates)


   .. py:method:: obs_long_to_phase(longitude)
      :abstractmethod:


   .. py:method:: phase_to_obs_long(phase)
      :abstractmethod:


   .. py:method:: phase_from_observer(obs_loc=(0, np.pi))
      :abstractmethod:


   .. py:method:: observer_from_phase(phase=0)
      :abstractmethod: