petitRADTRANS.containers.planet

Planet object.

Module Contents

Classes

Planet

class petitRADTRANS.containers.planet.Planet(name, mass=0.0, mass_error_upper=0.0, mass_error_lower=0.0, radius=0.0, radius_error_upper=0.0, radius_error_lower=0.0, orbit_semi_major_axis=0.0, orbit_semi_major_axis_error_upper=0.0, orbit_semi_major_axis_error_lower=0.0, orbital_eccentricity=0.0, orbital_eccentricity_error_upper=0.0, orbital_eccentricity_error_lower=0.0, orbital_inclination=0.0, orbital_inclination_error_upper=0.0, orbital_inclination_error_lower=0.0, orbital_period=0.0, orbital_period_error_upper=0.0, orbital_period_error_lower=0.0, argument_of_periastron=0.0, argument_of_periastron_error_upper=0.0, argument_of_periastron_error_lower=0.0, epoch_of_periastron=0.0, epoch_of_periastron_error_upper=0.0, epoch_of_periastron_error_lower=0.0, ra=0.0, dec=0.0, x=0.0, y=0.0, z=0.0, reference_pressure=0.01, density=0.0, density_error_upper=0.0, density_error_lower=0.0, surface_gravity=0.0, surface_gravity_error_upper=0.0, surface_gravity_error_lower=0.0, equilibrium_temperature=0.0, equilibrium_temperature_error_upper=0.0, equilibrium_temperature_error_lower=0.0, insolation_flux=0.0, insolation_flux_error_upper=0.0, insolation_flux_error_lower=0.0, bond_albedo=0.0, bond_albedo_error_upper=0.0, bond_albedo_error_lower=0.0, transit_depth=0.0, transit_depth_error_upper=0.0, transit_depth_error_lower=0.0, transit_midpoint_time=0.0, transit_midpoint_time_error_upper=0.0, transit_midpoint_time_error_lower=0.0, transit_duration=0.0, transit_duration_error_upper=0.0, transit_duration_error_lower=0.0, projected_obliquity=0.0, projected_obliquity_error_upper=0.0, projected_obliquity_error_lower=0.0, true_obliquity=0.0, true_obliquity_error_upper=0.0, true_obliquity_error_lower=0.0, radial_velocity_amplitude=0.0, radial_velocity_amplitude_error_upper=0.0, radial_velocity_amplitude_error_lower=0.0, planet_stellar_radius_ratio=0.0, planet_stellar_radius_ratio_error_upper=0.0, planet_stellar_radius_ratio_error_lower=0.0, semi_major_axis_stellar_radius_ratio=0.0, semi_major_axis_stellar_radius_ratio_error_upper=0.0, semi_major_axis_stellar_radius_ratio_error_lower=0.0, reference='', discovery_year=0, discovery_method='', discovery_reference='', confirmation_status='', host_name='', star_spectral_type='', star_mass=0.0, star_mass_error_upper=0.0, star_mass_error_lower=0.0, star_radius=0.0, star_radius_error_upper=0.0, star_radius_error_lower=0.0, star_age=0.0, star_age_error_upper=0.0, star_age_error_lower=0.0, star_metallicity=0.0, star_metallicity_error_upper=0.0, star_metallicity_error_lower=0.0, star_effective_temperature=0.0, star_effective_temperature_error_upper=0.0, star_effective_temperature_error_lower=0.0, star_luminosity=0.0, star_luminosity_error_upper=0.0, star_luminosity_error_lower=0.0, star_rotational_period=0.0, star_rotational_period_error_upper=0.0, star_rotational_period_error_lower=0.0, star_radial_velocity=0.0, star_radial_velocity_error_upper=0.0, star_radial_velocity_error_lower=0.0, star_rotational_velocity=0.0, star_rotational_velocity_error_upper=0.0, star_rotational_velocity_error_lower=0.0, star_density=0.0, star_density_error_upper=0.0, star_density_error_lower=0.0, star_surface_gravity=0.0, star_surface_gravity_error_upper=0.0, star_surface_gravity_error_lower=0.0, star_reference='', system_star_number=0, system_planet_number=0, system_moon_number=0, system_distance=0.0, system_distance_error_upper=0.0, system_distance_error_lower=0.0, system_apparent_magnitude_v=0.0, system_apparent_magnitude_v_error_upper=0.0, system_apparent_magnitude_v_error_lower=0.0, system_apparent_magnitude_j=0.0, system_apparent_magnitude_j_error_upper=0.0, system_apparent_magnitude_j_error_lower=0.0, system_apparent_magnitude_k=0.0, system_apparent_magnitude_k_error_upper=0.0, system_apparent_magnitude_k_error_lower=0.0, system_proper_motion=0.0, system_proper_motion_error_upper=0.0, system_proper_motion_error_lower=0.0, system_proper_motion_ra=0.0, system_proper_motion_ra_error_upper=0.0, system_proper_motion_ra_error_lower=0.0, system_proper_motion_dec=0.0, system_proper_motion_dec_error_upper=0.0, system_proper_motion_dec_error_lower=0.0, units=None)
default_planet_models_directory
calculate_planetary_equilibrium_temperature()

Calculate the equilibrium temperature of a planet.

get_filename()
save(filename=None)
classmethod from_tab_file(filename, use_best_mass=True)

Read from a NASA Exoplanet Archive Database .tab file. Args:

filename: file to read use_best_mass: if True, use NASA Exoplanet Archive Database ‘bmass’ argument instead of ‘mass’.

Returns:

planets: a list of Planet objects

classmethod from_votable(votable)
classmethod from_votable_file(filename)
classmethod get(name)
classmethod get_from(name, filename)
classmethod load(name, filename=None)
static __convert_nasa_exoplanet_archive(value, key, verbose=False, use_best_mass=False)
static calculate_full_transit_duration(total_transit_duration, planet_radius, star_radius, impact_parameter)
static calculate_impact_parameter(planet_orbit_semi_major_axis, planet_orbital_inclination, star_radius)
static calculate_planet_radial_velocity(planet_radial_velocity_amplitude, planet_orbital_inclination, orbital_longitude, **kwargs)

Calculate the planet radial velocity as seen by an observer.

Args:

planet_radial_velocity_amplitude: maximum radial velocity for an inclination angle of 90 degree planet_orbital_inclination: (degree) angle between the normal of the planet orbital plane and the axis of

observation, i.e. 90 degree: edge view, 0 degree: top view

orbital_longitude: (degree) angle between the closest point from the observer on the planet orbit and the

planet position, i.e. if the planet orbital inclination is 0 degree, 0 degree: mid-primary transit point, 180 degree: mid-secondary eclipse point

Returns:

static calculate_orbital_velocity(star_mass, semi_major_axis)

Calculate an approximation of the orbital velocity. This equation is valid if the mass of the object is negligible compared to the mass of the star, and if the eccentricity of the object is close to 0.

Args:

star_mass: (g) mass of the star semi_major_axis: (cm) semi-major axis of the orbit of the object

Returns: (cm.s-1) the mean orbital velocity, assuming 0 eccentricity and mass_object << mass_star

static generate_filename(name, directory=default_planet_models_directory)
static get_astropy_coordinates(ra, dec, site_name=None, latitude=None, longitude=None, height=None)
static get_airmass(ra, dec, time, site_name=None, latitude=None, longitude=None, height=None, time_format='mjd')
static get_barycentric_velocities(ra, dec, time, site_name=None, latitude=None, longitude=None, height=None, time_format='mjd')
static get_simple_transit_curve(time_from_mid_transit, planet_radius, star_radius, planet_orbital_velocity=None, star_mass=None, orbit_semi_major_axis=None)

Assume no inclination, circular orbit, observer infinitely far away, spherical objects, perfectly sharp and black planet and perfectly sharp and uniformly luminous star.

Args:

time_from_mid_transit: (s) time from mid-transit, 0 is the mid-transit time, < 0 before and > 0 after planet_radius: (cm) radius of the planet star_radius: (cm) radius of the star planet_orbital_velocity: (cm.s-1) planet velocity along its orbit. star_mass: (g) mass of the star orbit_semi_major_axis: (cm) planet orbit semi major axis

Returns:

static get_orbital_phases(phase_start, orbital_period, times)

Calculate orbital phases assuming low eccentricity.

Args:

phase_start: planet phase at the start of observations orbital_period: (s) orbital period of the planet times: (s) time array

Returns:

The orbital phases for the given time

static download_from_nasa_exoplanet_archive(name)
static select_best_in_column(dictionary)
static mass2surface_gravity(mass, radius, mass_error_upper=0.0, mass_error_lower=0.0, radius_error_upper=0.0, radius_error_lower=0.0)

Convert the mass of a planet to its surface gravity. Args:

mass: (g) mass of the planet radius: (cm) radius of the planet mass_error_upper: (g) upper error on the planet mass mass_error_lower: (g) lower error on the planet mass radius_error_upper: (cm) upper error on the planet radius radius_error_lower: (cm) lower error on the planet radius

Returns:

(cm.s-2) the surface gravity of the planet, and its upper and lower error

static surface_gravity2radius(surface_gravity, mass, surface_gravity_error_upper=0.0, surface_gravity_error_lower=0.0, mass_error_upper=0.0, mass_error_lower=0.0)

Convert the mass of a planet to its surface gravity. Args:

surface_gravity: (cm.s-2) surface_gravity of the planet mass: (g) mass of the planet mass_error_upper: (g) upper error on the planet mass mass_error_lower: (g) lower error on the planet mass surface_gravity_error_upper: (cm.s-2) upper error on the planet radius surface_gravity_error_lower: (cm.s-2) lower error on the planet radius

Returns:

(cm.s-2) the surface gravity of the planet, and its upper and lower error

static surface_gravity2mass(surface_gravity, radius, surface_gravity_error_upper=0.0, surface_gravity_error_lower=0.0, radius_error_upper=0.0, radius_error_lower=0.0)

Convert the surface gravity of a planet to its mass. Args:

surface_gravity: (cm.s-2) surface gravity of the planet radius: (cm) radius of the planet surface_gravity_error_upper: (cm.s-2) upper error on the planet surface gravity surface_gravity_error_lower: (cm.s-2) lower error on the planet surface gravity radius_error_upper: (cm) upper error on the planet radius radius_error_lower: (cm) lower error on the planet radius

Returns:

  1. the mass of the planet, and its upper and lower error