jaxoplanet.orbits.transit

jaxoplanet.orbits.transit#

Classes#

TransitOrbit

An orbit parameterized by the transit signal parameters.

Module Contents#

class jaxoplanet.orbits.transit.TransitOrbit(*, period: jaxoplanet.types.Scalar, duration: jaxoplanet.types.Scalar | None = None, speed: jaxoplanet.types.Scalar | None = None, time_transit: jaxoplanet.types.Scalar | None = None, impact_param: jaxoplanet.types.Scalar | None = None, radius_ratio: jaxoplanet.types.Scalar | None = None)[source]#

Bases: equinox.Module

An orbit parameterized by the transit signal parameters.

Parameters:

  • period – Orbital periods of the planets [time unit].

  • duration (Optional[Scalar]) – Durations of transits [time unit]. Either this or speed must be provided.

  • speed (Optional[Scalar]) – Speeds of the planets [length/time unit]. Either this or duration must be provided.

  • time_transit (Optional[Scalar]) – The epochs of reference transits [time unit]. Default is 0.

  • impact_param (Optional[Scalar]) – Impact parameters of the transits. Default is 0.

  • radius_ratio (Optional[Scalar]) – Ratio of planet radii to star radius. Default is 0.

Raises:

ValueError – If neither speed nor duration is provided.

Properties:

  • shape: Returns the shape of the period, i.e. the number of planets.

  • central_radius: A Scalar representing the radius of the central body.

    Its value is always 1 in this class, but required for compatibility reasons.

  • radius: An alias for radius_ratio required for compatibility reasons.

  • relative_position: The relative position of the orbiting body at a given time.

period: jaxoplanet.types.Scalar[source]#
speed: jaxoplanet.types.Scalar[source]#
duration: jaxoplanet.types.Scalar[source]#
time_transit: jaxoplanet.types.Scalar[source]#
impact_param: jaxoplanet.types.Scalar[source]#
radius_ratio: jaxoplanet.types.Scalar[source]#
property shape: tuple[int, Ellipsis][source]#
property radius: jaxoplanet.types.Scalar[source]#
property central_radius: jaxoplanet.types.Scalar[source]#
relative_position(t: jaxoplanet.types.Scalar, parallax: jaxoplanet.types.Scalar | None = None) → tuple[jaxoplanet.types.Scalar, jaxoplanet.types.Scalar, jaxoplanet.types.Scalar][source]#
Contents