Source code for rms.star

# Licensed under the MIT License - see LICENSE

__all__ = ['Star']


class Star(object):
    """
    A ``batman.TransitParams``-like object for stellar parameters, to use as
    inputs for STSP.
    """
    def __init__(self, rotation_period, inc_stellar, spot_contrast, u=[0.2, 0.1],
                 limb_dark='quadratic'):
        """
        Parameters
        ----------
        rotation_period : float
            Stellar rotation period in days
        inc_stellar : float
            Stellar inclination (measured away from observer's line-of-sight)
            in units of degrees
        spot_contrast : float
            Relative intensity of a spot to the photosphere (0==perfectly dark,
            1==same as photosphere)
        u : list
            Limb darkening parameters
        limb_dark : str
            Limb darkening law
        """
        self.per = 100
        self.inc = 0
        self.a = 100
        self.t0 = 0
        self.u = u
        self.limb_dark = limb_dark
        self.rp = 0.1
        self.ecc = 0
        self.w = 90
        self.inc_stellar = inc_stellar
        self.lam = 0
        self.b = 2
        self.duration = 0.1
        self.per_rot = rotation_period
        self.spot_contrast = spot_contrast