Analytical transit model (Mandel & Agol 2002)
======================================================

.. p23ready

The *forTrans* module provides easy access to the FORTRAN
routines by Mandel & Agol 2002 [#ManAg02]_, which can be used to
calculate transit light curves. While the FORTRAN code ensures
fast computation of the light curve, PyAstronomy supplies
funcFit's fitting framework.

.. note:: The code contained within the files *occultnl.f* and *occultquad.f* is used
          with kind permission of the authors. It is described in [#ManAg02]_; further
          explanations are given in Eastman et al. 2013 (PASP 125, 83).

.. [#ManAg02] Mandel & Agol 2002, "Analytic Light Curves for Planetary Transit Searches", ApJ, 580, 171.

The MandelAgolLC class
----------------------------

The MandelAgolLC model can be used to calculate transit light curves
with quadratic or non-linear limb darkening based on a circular or
general Keplerian orbit.

.. currentmodule:: PyAstronomy.modelSuite.XTran.forTrans.mandelAgol
.. autoclass:: MandelAgolLC


Example: Calculate model light curve (circular orbit, quadratic limb darkening)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::
    
    # Import some unrelated modules
    import numpy as np
    import matplotlib.pylab as plt
    # ... and now the forTrans module
    from PyAstronomy.modelSuite import forTrans as ft
    
    
    # Create MandelAgolLC object with
    # circular orbit and quadratic limb darkening
    ma = ft.MandelAgolLC(orbit="circular", ld="quad")
    
    # See the available parameters and their current values
    ma.parameterSummary()
    
    # Set parameters
    ma["per"] = 0.2
    ma["i"] = 90.0
    ma["a"] = 6.5
    ma["T0"] = 0.0
    ma["p"] = 0.16
    ma["linLimb"] = 0.47
    ma["quadLimb"] = 0.24
    ma["b"] = 0.
    
    # Choose some time axis
    time = np.linspace(0, 0.5, 1000)
    
    # ... and calculate model
    y = ma.evaluate(time)
    
    # Let's see what happened ...
    plt.plot(time, y, 'b.')
    plt.show()


Example: Calculate model light curve (keplerian orbit, quadratic limb darkening)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::
    
    # Import some unrelated modules
    import numpy as np
    import matplotlib.pylab as plt
    # ... and now the forTrans module
    from PyAstronomy.modelSuite import forTrans as ft
    
    
    # Create MandelAgolLC object with
    # keplerian orbit and quadratic limb darkening
    ma = ft.MandelAgolLC(orbit="keplerian", ld="quad")
    
    # See the available parameters and their current values
    ma.parameterSummary()
    
    # Set parameters
    ma["per"] = 0.2
    ma["i"] = 88.76
    ma["a"] = 6.5
    ma["p"] = 0.16
    ma["linLimb"] = 0.47
    ma["quadLimb"] = 0.24
    ma["b"] = 0.
    ma["e"] = 0.75
    ma["w"] = 127.
    ma["Omega"] = 3.9
    
    # Choose some time axis
    time = np.linspace(0, 0.5, 1000)
    
    # ... and calculate model
    y = ma.evaluate(time)
    
    # Let's see what happened ...
    plt.plot(time, y, 'b.')
    plt.show()
        

Example: Comparing limb-darkening laws
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::
    
    # Import some modules
    import numpy as np
    import matplotlib.pylab as plt
    # ... and now the forTrans module
    from PyAstronomy.modelSuite import forTrans as ft
    
    # First, let's compute a transit model using
    # quadratic limb-darkening prescription.
    ma = ft.MandelAgolLC(ld="quad")
    
    # Set parameters. The LD coefficients are taken
    # from Claret 2011 for a solar-metallicity star
    # with Teff=6000 K and logg=4.5.
    ma["per"] = 0.2
    ma["i"] = 90.0
    ma["a"] = 6.5
    ma["T0"] = 0.5
    ma["p"] = 0.16
    ma["linLimb"] = 0.0479
    ma["quadLimb"] = 0.2716
    ma["b"] = 0.
    
    # Choose some time axis
    time = np.linspace(0, 0.2, 1000)
    
    # ... and calculate model
    yQLD = ma.evaluate(time)
    
    # Now, let's compute a transit model with
    # non-linear limb-darkening prescription
    # for the same stellar parameters.
    maNL = ft.MandelAgolLC(ld="nl")
    maNL["per"] = 0.2
    maNL["i"] = 90.0
    maNL["a"] = 6.5
    maNL["T0"] = 0.5
    maNL["p"] = 0.16
    maNL["a1"] = 0.5335
    maNL["a2"] = 0.0793
    maNL["a3"] = -0.3466
    maNL["a4"] = 0.1609
    maNL["b"] = 0.
    
    yNLLD = maNL.evaluate(time)
    
    # Let's compare both models...
    plt.plot(time, yQLD, '-', label="Quadratic LD")
    plt.plot(time, yNLLD, 'd', label="Non-linear LD")
    plt.legend()
    plt.show()


Non-linear limb-darkening - The MandelAgolNLLC class
----------------------------------------------------

.. warning:: The mandelAgolNL is considered deprecated. Its functionality
             has been absorbed in the MandelAgolLC model.

.. currentmodule:: PyAstronomy.modelSuite.XTran.forTrans.mandelAgolNL
.. autoclass:: MandelAgolNLLC