Maps

Maps are instantiated via the starry.Map() class factory, which returns one of several different kinds of maps, depending on the arguments passed to it.

starry.Map(ydeg=0, udeg=0, nw=None, rv=False, reflected=False, source_npts=1, lazy=None, **kwargs)

A generic starry surface map.

This function is a class factory that returns either a spherical harmonic map, a limb darkened map, a radial velocity map, or a reflected light map, depending on the arguments provided by the user. The default is a spherical harmonic map. If rv is True, instantiates a radial velocity map map, and if reflected is True, instantiates a reflected light map. Otherwise, if ydeg is zero, instantiates a limb darkened map.

Parameters

  • ydeg (int, optional) – Degree of the spherical harmonic map. Defaults to 0.

  • udeg (int, optional) – Degree of the limb darkening filter. Defaults to 0.

  • nw (int, optional) – Number of wavelength bins. Defaults to None (for monochromatic light curves).

  • rv (bool, optional) – If True, enable computation of radial velocities for modeling the Rossiter-McLaughlin effect. Defaults to False.

  • reflected (bool, optional) – If True, models light curves in reflected light. Defaults to False.

  • source_npts (int, optional) – Number of points used to approximate the finite illumination source size. Default is 1. Valid only if reflected is True.

Classes instantiated by this function: