Primary Keplerian body

class starry.Primary

A primary (central) body.

Parameters

• map – The surface map of this body. This should be an instance returned by starry.Map().

• r (scalar, optional) – The radius of the body in units of length_unit. Defaults to 1.0.

• m (scalar, optional) – The mass of the body in units of mass_unit. Defaults to 1.0.

• prot (scalar, optional) – The rotation period of the body in units of time_unit. Defaults to 1.0.

• t0 (scalar, optional) – A reference time in units of time_unit. Defaults to 0.0.

• theta0 (scalar, optional) – The rotational phase of the map at time t0 in units of angle_unit. Defaults to 0.0.

• length_unit (optional) – An astropy.units unit defining the distance metric for this object. Defaults to astropy.units.Rsun.

• mass_unit (optional) – An astropy.units unit defining the mass metric for this object. Defaults to astropy.units.Msun.

• time_unit (optional) – An astropy.units unit defining the time metric for this object. Defaults to astropy.units.day.

• angle_unit (optional) – An astropy.units unit defining the angular metric for this object. Defaults to astropy.units.degree.

property angle_unit

An astropy.units unit defining the angle metric for this body.

property length_unit

An astropy.units unit defining the length metric for this body.

property m

The mass in units of mass_unit.

property map

The surface map for this body.

property mass_unit

An astropy.units unit defining the mass metric for this body.

property prot

The rotation period in units of time_unit.

property r

The radius in units of length_unit.

property t0

A reference time in units of time_unit.

property theta0

The map rotational phase at time t0.

property time_unit

An astropy.units unit defining the time metric for this body.