curryer.compute.ephemeris
=========================

.. py:module:: curryer.compute.ephemeris

.. autoapi-nested-parse::

   Ephemeris related routines.

   Routine Listings
   ----------------
   SolarDistAndDoppler(instrument, mission=None, kernels=None)
       Class for working with TIM solar distance and doppler data.

   .. rubric:: Examples

   >>> ugps_range = (1135641617000000, 1135728017000000)  # 2016-01-01 & 2016-01-02
   >>> sdad = SolarDistAndDoppler('tcte', mission='tcte')
   >>> table = sdad.get_corrections(ugps_range)
   >>> print(table.head())

   @author: Brandon Stone



Attributes
----------

.. autoapisummary::

   curryer.compute.ephemeris.logger


Classes
-------

.. autoapisummary::

   curryer.compute.ephemeris.SolarDistAndDoppler


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

.. py:data:: logger

.. py:class:: SolarDistAndDoppler(observer, microsecond_cadence=None)

   Bases: :py:obj:`curryer.compute.abstract.AbstractMissionData`


   Solar distance and Doppler server.


   .. py:attribute:: DEFAULT_CADENCE
      :value: 60000000



   .. py:attribute:: observer


   .. py:attribute:: position_columns
      :value: ['x', 'y', 'z']



   .. py:attribute:: velocity_columns
      :value: ['vx', 'vy', 'vz']



   .. py:method:: _dist_correction(state)

      TIM distance correction.

      Definition:
          (R_1au / R_actual)^2
      where
          R_1au = KM per 1AU (constant)
          R_actual = KM between target and observer

      :param state: Table of ephemeris state data. Columns: [x, y, z, vx, vy, vz].
                    Units must be KM & KM/Sec.
      :type state: pandas.DataFrame

      :returns: Array of distance correction factors.
      :rtype: numpy.ndarray



   .. py:method:: _doppler_correction(state)

      Doppler correction.

      Definition:
          (1 - (R_vel / c))
      where
          R_vel = Radial velocity (KM/sec)
              dot(velocity, position) / norm(position)
          c = Speed of light (vacuum; constant; KM/sec)

      :param state: Table of ephemeris state data. Columns: [x, y, z, vx, vy, vz].
                    Units must be KM & KM/Sec.
      :type state: pandas.DataFrame

      :returns: Array of doppler correction factors.
      :rtype: numpy.ndarray



   .. py:method:: get_corrections(ugps_times)

      Generate a table of the SDD corrections.