:py:mod:`rubin_lc_simulator.lightcurves`
========================================

.. py:module:: rubin_lc_simulator.lightcurves

.. autoapi-nested-parse::

   Created on Thu Jun 28 20:30:11 2018

   @author: danielgodinez



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


Functions
~~~~~~~~~

.. autoapisummary::

   rubin_lc_simulator.lightcurves.constant
   rubin_lc_simulator.lightcurves.microlensing



.. py:function:: constant(timestamps: numpy.typing.ArrayLike, baseline: float) -> numpy.ndarray

   Generate a non-variable light curve.

   :param timestamps: Observation epochs (any shape) in days.
   :type timestamps: array-like
   :param baseline: Constant magnitude to assign.
   :type baseline: float

   :returns: Array with the same shape as `timestamps`, filled with `baseline`.
   :rtype: np.ndarray


.. py:function:: microlensing(timestamps: numpy.typing.ArrayLike, baseline: float, t0_dist: Tuple[float, float] | None = None, u0_dist: Tuple[float, float] | None = None, tE_dist: Tuple[float, float] | None = None) -> Tuple[numpy.ndarray, float, float, float, float]

   Simulate a single-lens, point-source microlensing event with blending.

   If not defined, the microlensing parameter space is determined using data from an
   analysis of the OGLE III microlensing survey from Y. Tsapras et al (2016).
   See: The OGLE-III planet detection efficiency from six years of microlensing observations (2003 to 2008).
   (https://arxiv.org/abs/1602.02519)

   :param timestamps: Observation epochs (days).
   :type timestamps: array-like
   :param baseline: Baseline magnitude outside the event.
   :type baseline: float
   :param t0_dist: Uniform bounds for ``t0`` (time of peak).  Defaults to the middle
                   98% of the supplied `timestamps` plus a cushion of 0.5 `t_E` on each
                   side.
   :type t0_dist: (float, float), optional
   :param u0_dist: Uniform bounds for ``u0`` (impact parameter).  Default: (0, 1).
   :type u0_dist: (float, float), optional
   :param tE_dist: Mean and standard deviation for normally distributed ``t_E``
                   (Einstein-radius crossing time).  Default: 30 plus/minus 10 days.
   :type tE_dist: (float, float), optional

   :returns:

             * `mag` – simulated magnitudes (np.ndarray)
             * `u0` – drawn impact parameter
             * `t0` – drawn peak time (days)
             * `tE` – drawn event timescale (days)
             * `blend_ratio` – flux blending ratio *f_b / f_s*
   :rtype: Tuple