boinor.plotting.tisserand
=========================

.. py:module:: boinor.plotting.tisserand

.. autoapi-nested-parse::

   Generates Tisserand plots.



Classes
-------

.. autoapisummary::

   boinor.plotting.tisserand.TisserandKind
   boinor.plotting.tisserand.TisserandPlotter


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

.. py:class:: TisserandKind(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   All possible Tisserand kinds.


   .. py:attribute:: APSIS
      :value: 'apsis'



   .. py:attribute:: ENERGY
      :value: 'energy'



   .. py:attribute:: PERIOD
      :value: 'period'



.. py:class:: TisserandPlotter(kind=TisserandKind.APSIS, axes=None)

   Generates Tisserand figures.


   .. py:attribute:: kind


   .. py:method:: plot_line(body, vinf, alpha_lim=(0, np.pi), color=None)

      Plots body Tisserand line within flyby angle.

      :param body: Body to be plotted Tisserand
      :type body: ~boinor.bodies.Body
      :param vinf: Vinf velocity line
      :type vinf: ~astropy.units.Quantity
      :param alpha_lim: Minimum and maximum flyby angles
      :type alpha_lim: tuple
      :param color: String representing for the color lines
      :type color: str

      :returns: **self.ax** -- Apsis tisserand is the default plotting option
      :rtype: ~matplotlib.axes.Axes



   .. py:method:: plot(body, vinf_span, num_contours=10, color=None)

      Plots body Tisserand for given amount of solutions within Vinf span.

      :param body: Body to be plotted Tisserand
      :type body: ~boinor.bodies.Body
      :param vinf_span: Minimum and maximum Vinf velocities
      :type vinf_span: tuple
      :param num_contours: Number of points to iterate over previously defined velocities
      :type num_contours: int
      :param color: String representing for the color lines
      :type color: str

      :returns: **self.ax** -- Apsis tisserand is the default plotting option
      :rtype: ~matplotlib.axes.Axes