General model¶

class
pytransit.
GeneralModel
(npol: int = 50, nldc: int = 2, mode: int = 0)[source]¶ Transit model with general limb darkening (Giménez, A&A 450, 1231–1237, 2006).
Transit model with general limb darkening (Giménez, A&A 450, 1231–1237, 2006) with optimizations described in Parviainen (MNRAS 450, 3233–3238, 2015).
The general limb darkening law is

__init__
(npol: int = 50, nldc: int = 2, mode: int = 0)[source]¶ Initialize self. See help(type(self)) for accurate signature.

set_data
(time: Union[numpy.ndarray, List[T]], lcids: Union[numpy.ndarray, List[T], None] = None, pbids: Union[numpy.ndarray, List[T], None] = None, nsamples: Union[numpy.ndarray, List[T], None] = None, exptimes: Union[numpy.ndarray, List[T], None] = None, epids: Union[numpy.ndarray, List[T], None] = None) → None¶ Set the data for the transit model.
Parameters:  time (arraylike) – Array of midexposure times for which the model will be evaluated.
 lcids (arraylike, optional) – Array of integer light curve indices. Must have the same size as the time array.
 pbids (arraylike, optional) – Array of passband indices, one per light curve. Must satisfy pbids.size == unique(lcids).size.
 nsamples (int or arraylike, optional) – Number of samples per exposure. Can either be an integer, in which case all the light curves will have the same supersampling rate, or an array of integers, in which case each light curve can have a different rate.
 exptimes (float or arraylike, optional) – Exposure times, again either for all the modelled data, or one value per light curve.
 epids (arraylike, optional) – Epoch indices that can be used to link a light curve to a specific zero epoch and period (for TTV calculations).

evaluate
(k: Union[float, numpy.ndarray], ldc: Union[numpy.ndarray, List[T]], t0: Union[float, numpy.ndarray], p: Union[float, numpy.ndarray], a: Union[float, numpy.ndarray], i: Union[float, numpy.ndarray], e: Union[float, numpy.ndarray, None] = None, w: Union[float, numpy.ndarray, None] = None, copy: bool = True) → numpy.ndarray[source]¶ Evaluate the transit model for a set of scalar or vector parameters.
Parameters:  k – Radius ratio(s) either as a single float, 1D vector, or 2D array.
 ldc – Limb darkening coefficients as a 1D or 2D array.
 t0 – Transit center(s) as a float or a 1D vector.
 p – Orbital period(s) as a float or a 1D vector.
 a – Orbital semimajor axis (axes) divided by the stellar radius as a float or a 1D vector.
 i – Orbital inclination(s) as a float or a 1D vector.
 e (optional) – Orbital eccentricity as a float or a 1D vector.
 w (optional) – Argument of periastron as a float or a 1D vector.
Notes
The model can be evaluated either for one set of parameters or for many sets of parameters simultaneously. In the first case, the orbital parameters should all be given as floats. In the second case, the orbital parameters should be given as a 1D arraylike.
Returns: Modelled flux either as a 1D or 2D ndarray. Return type: ndarray

evaluate_ps
(k: Union[float, numpy.ndarray], ldc: numpy.ndarray, t0: float, p: float, a: float, i: float, e: float = 0.0, w: float = 0.0, copy: bool = True) → numpy.ndarray[source]¶ Evaluate the transit model for a set of scalar parameters.
Parameters:  k (arraylike) – Radius ratio(s) either as a single float or an 1D array.
 ldc (arraylike) – Limb darkening coefficients as a 1D array.
 t0 (float) – Transit center as a float.
 p (float) – Orbital period as a float.
 a (float) – Orbital semimajor axis divided by the stellar radius as a float.
 i (float) – Orbital inclination(s) as a float.
 e (float, optional) – Orbital eccentricity as a float.
 w (float, optional) – Argument of periastron as a float.
Notes
This version of the evaluate method is optimized for calculating a single transit model (such as when using a local optimizer). If you want to evaluate the model for a large number of parameters simultaneously, use either evaluate or evaluate_pv.
Returns: Modelled flux as a 1D ndarray. Return type: ndarray

evaluate_pv
(pvp: numpy.ndarray, ldc: numpy.ndarray, copy: bool = True) → numpy.ndarray[source]¶ Evaluate the transit model for a 2D parameter array.
Parameters:  pvp (ndarray) – Parameter array with a shape (npv, npar) where npv is the number of parameter vectors, and each row contains a set of parameters [k, t0, p, a, i, e, w]. The radius ratios can also be given per passband, in which case the row should be structured as [k_0, k_1, k_2, …, k_npb, t0, p, a, i, e, w].
 ldc (ndarray) – Limb darkening coefficient array with shape (npv, 2*npb), where npv is the number of parameter vectors and npb is the number of passbands.
Notes
This version of the evaluate method is optimized for calculating several models in parallel, such as when using emcee for MCMC sampling.
Returns: Modelled flux either as a 1D or 2D ndarray. Return type: ndarray
