boinor.earth.plotting.groundtrack
=================================

.. py:module:: boinor.earth.plotting.groundtrack

.. autoapi-nested-parse::

   Holds ground-track plotter for Earth satellites.



Classes
-------

.. autoapisummary::

   boinor.earth.plotting.groundtrack.GroundtrackPlotter


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

.. py:class:: GroundtrackPlotter(fig=None, color_palette=EARTH_PALETTE)

   Generates two-dimensional ground-track.


   .. py:method:: update_geos(**config)

      Enables user to customize geo figure.

      :param \*\*config: A collection of custom values for geo figure
      :type \*\*config: dict



   .. py:method:: update_layout(**config)

      Enables user to customize figure layout.

      :param \*\*config: A collection of custom values for figure layout
      :type \*\*config: dict



   .. py:method:: add_trace(trace)

      Adds trace to custom figure.



   .. py:method:: plot(earth_orb, t_span, label, color, line_style={}, marker={})

      Plots desired Earth satellite orbit for a given time span.

      :param earth_orb: Desired Earth's satellite to who's grountrack will be plotted
      :type earth_orb: ~boinor.earth.EarthSatellite
      :param t_span: A collection of epochs
      :type t_span: ~astropy.time.TimeDelta
      :param label: Label for the groundtrack.
      :type label: str
      :param color: Desired lines and traces color
      :type color: string
      :param line_style: Dictionary for customizing groundtrack line trace
      :type line_style: dict
      :param marker: Dictionary for customizing groundtrack marker trace
      :type marker: dict

      :returns: **fig** -- Output figure
      :rtype: ~plotly.graph_objects.Figure