boinor.plotting.porkchop
========================

.. py:module:: boinor.plotting.porkchop

.. autoapi-nested-parse::

   This is the implementation of porkchop plot.



Attributes
----------

.. autoapisummary::

   boinor.plotting.porkchop.targetting_vec


Classes
-------

.. autoapisummary::

   boinor.plotting.porkchop.PorkchopPlotter


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

.. py:data:: targetting_vec

.. py:class:: PorkchopPlotter(departure_body, target_body, launch_span, arrival_span, ax=None, tfl=True, vhp=True, max_c3=45.0 * u.km**2 / u.s**2, max_vhp=5 * u.km / u.s)

   Class Implementation for Porkchop Plot.

   :param departure_body: Body from which departure is done
   :type departure_body: boinor.bodies.Body
   :param target_body: Body for targetting
   :type target_body: boinor.bodies.Body
   :param launch_span: Time span for launch
   :type launch_span: astropy.time.Time
   :param arrival_span: Time span for arrival
   :type arrival_span: astropy.time.Time
   :param ax: For custom figures
   :type ax: matplotlib.axes.Axes
   :param tfl: For plotting time flight contour lines
   :type tfl: bool
   :param vhp: For plotting arrival velocity contour lines
   :type vhp: bool
   :param max_c3: Sets the maximum C3 value for porkchop
   :type max_c3: float
   :param max_vhp: Sets the maximum arrival velocity for porkchop
   :type max_vhp: float


   .. py:attribute:: departure_body


   .. py:attribute:: target_body


   .. py:attribute:: launch_span


   .. py:attribute:: arrival_span


   .. py:attribute:: ax
      :value: None



   .. py:attribute:: tfl
      :value: True



   .. py:attribute:: vhp
      :value: True



   .. py:attribute:: max_c3


   .. py:attribute:: max_vhp


   .. py:method:: plot()

      Plots porkchop between two bodies.

      :returns: * **dv_launch** (*numpy.ndarray*) -- Launch delta v
                * **dv_arrival** (*numpy.ndarray*) -- Arrival delta v
                * **c3_launch** (*numpy.ndarray*) -- Characteristic launch energy
                * **c3_arrrival** (*numpy.ndarray*) -- Characteristic arrival energy
                * **tof** (*numpy.ndarray*) -- Time of flight for each transfer

      .. rubric:: Examples

      >>> from boinor.plotting.porkchop import PorkchopPlotter
      >>> from boinor.bodies import Earth, Mars
      >>> from boinor.util import time_range
      >>> launch_span = time_range("2005-04-30", end="2005-10-07")
      >>> arrival_span = time_range("2005-11-16", end="2006-12-21")
      >>> porkchop_plot = PorkchopPlotter(Earth, Mars, launch_span, arrival_span)
      >>> dv_launch, dev_dpt, c3dpt, c3arr, tof = porkchop_plot.porkchop()



   .. py:method:: porkchop()