Secondary Keplerian body

class starry.Secondary

A secondary (orbiting) 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.

  • a (scalar, optional) – The semi-major axis of the body in units of time_unit. Defaults to 1.0. If porb is also provided, this value is ignored.

  • porb (scalar, optional) – The orbital period of the body in units of time_unit. Defaults to 1.0. Setting this value overrides a.

  • 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. This is taken to be the time of a reference transit. Defaults to 0.0.

  • ecc (scalar, optional) – The orbital eccentricity of the body. Defaults to 0.

  • w (scalar, optional) – The argument of pericenter of the body in units of angle_unit. Defaults to 90 degrees.

  • omega (scalar, optional) – The argument of pericenter of the body in units of angle_unit. Defaults to 90 degrees.

  • Omega (scalar, optional) – The longitude of ascending node of the body in units of angle_unit. Defaults to 0 degrees.

  • inc (scalar, optional) – The orbital inclination of the body in units of angle_unit. Defaults to 90 degrees.

  • 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 Omega

The longitude of ascending node in units of angle_unit.

property a

The semi-major axis in units of length_unit.

Note

Setting this value overrides the value of porb.

property angle_unit

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

property ecc

The orbital eccentricity.

property inc

The orbital inclination in units of angle_unit.

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 omega

Alias for the longitude of pericenter w.

property porb

The orbital period in units of time_unit.

Note

Setting this value overrides the value of a.

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.

property w

The longitude of pericenter in units of angle_unit.