Forward Models (taurex.model)

Base

class ForwardModel(name)

Bases: taurex.log.logger.Logger, taurex.data.fittable.Fittable, taurex.output.writeable.Writeable, taurex.data.citation.Citable

A base class for producing forward models

add_contribution(contrib)

build()

citations()

compute_error(samples, wngrid=None, binner=None)

defaultBinner()

property derivedParameters

property fittingParameters

generate_profiles()

Must return a dictionary of profiles you want to store after modeling

classmethod input_keywords()

model(wngrid=None, cutoff_grid=True)

Computes the forward model for a wngrid

model_full_contrib(wngrid=None, cutoff_grid=True)

Computes the forward model for a wngrid for each contribution

write(output)

Basic Model

class SimpleForwardModel(name, planet=None, star=None, pressure_profile=None, temperature_profile=None, chemistry=None, nlayers=100, atm_min_pressure=0.0001, atm_max_pressure=1000000.0)

Bases: taurex.model.model.ForwardModel

A ‘simple’ base model in the sense that its just a fairly standard single profiles model. It will handle settingup and initializing, building collecting parameters from given profiles for you. The only method that requires implementation is:

• path_integral()

Parameters

• name (str) – Name to use in logging

• planet (Planet, optional) – Planet model, default planet is Jupiter

• star (Star, optional) – Star model, default star is Sun-like

• pressure_profile (PressureProfile, optional) – Pressure model, alternative is to set nlayers, atm_min_pressure and atm_max_pressure

• temperature_profile (TemperatureProfile, optional) – Temperature model, default is an Isothermal profile at 1500 K

• chemistry (Chemistry, optional) – Chemistry model, default is TaurexChemistry with H2O and CH4

• nlayers (int, optional) – Number of layers. Used if pressure_profile is not defined.

• atm_min_pressure (float, optional) – Pressure at TOA. Used if pressure_profile is not defined.

• atm_max_pressure (float, optional) – Pressure at BOA. Used if pressure_profile is not defined.

property altitudeProfile

Atmospheric altitude profile in m

build()

Build the forward model. Must be called at least once before running model()

property chemistry

Chemistry model

citations()

collect_derived_parameters()

Collects all derived parameters from all profiles within the forward model

collect_fitting_parameters()

Collects all fitting parameters from all profiles within the forward model

compute_error(samples, wngrid=None, binner=None)

Computes standard deviations from samples

Parameters

samples –

property densityProfile

Atmospheric density profile in m-3

generate_profiles()

Must return a dictionary of profiles you want to store after modeling

initialize_profiles()

Initializes all profiles

model(wngrid=None, cutoff_grid=True)

Runs the forward model

Parameters

• wngrid (array, optional) – Wavenumber grid, default is to use native grid

• cutoff_grid (bool) – Run model only on wngrid given, default is True

Returns

• native_grid (array) – Native wavenumber grid, clipped if wngrid passed

• depth (array) – Resulting depth

• tau (array) – Optical depth.

• extra (None) – Empty

model_contrib(wngrid=None, cutoff_grid=True)

Models each contribution seperately

model_full_contrib(wngrid=None, cutoff_grid=True)

Like model_contrib() except all components for each contribution are modelled

property nLayers

Number of layers

property nativeWavenumberGrid

Searches through active molecules to determine the native wavenumber grid

Returns

wngrid – Native grid

Return type

array

Raises

InvalidModelException – If no active molecules in atmosphere

path_integral(wngrid, return_contrib)

property planet

Planet model

property pressure

Pressure model

property pressureProfile

Atmospheric pressure profile in Pa

property star

Star model

property temperature

Temperature model

property temperatureProfile

Atmospheric temperature profile in K

write(output)

Transmission

class TransmissionModel(planet=None, star=None, pressure_profile=None, temperature_profile=None, chemistry=None, nlayers=100, atm_min_pressure=0.0001, atm_max_pressure=1000000.0, new_path_method=False)

Bases: taurex.model.simplemodel.SimpleForwardModel

A forward model for transits

Parameters

• planet (Planet, optional) – Planet model, default planet is Jupiter

• star (Star, optional) – Star model, default star is Sun-like

• pressure_profile (PressureProfile, optional) – Pressure model, alternative is to set nlayers, atm_min_pressure and atm_max_pressure

• temperature_profile (TemperatureProfile, optional) – Temperature model, default is an Isothermal profile at 1500 K

• chemistry (Chemistry, optional) – Chemistry model, default is TaurexChemistry with H2O and CH4

• nlayers (int, optional) – Number of layers. Used if pressure_profile is not defined.

• atm_min_pressure (float, optional) – Pressure at TOA. Used if pressure_profile is not defined.

• atm_max_pressure (float, optional) – Pressure at BOA. Used if pressure_profile is not defined.

compute_absorption(tau, dz)

compute_path_length()

compute_path_length_old(dz)

classmethod input_keywords()

path_integral(wngrid, return_contrib)

Emission

class EmissionModel(planet=None, star=None, pressure_profile=None, temperature_profile=None, chemistry=None, nlayers=100, atm_min_pressure=0.0001, atm_max_pressure=1000000.0, ngauss=4)

Bases: taurex.model.simplemodel.SimpleForwardModel

A forward model for eclipses

Parameters

• planet (Planet, optional) – Planet model, default planet is Jupiter

• star (Star, optional) – Star model, default star is Sun-like

• pressure_profile (PressureProfile, optional) – Pressure model, alternative is to set nlayers, atm_min_pressure and atm_max_pressure

• temperature_profile (TemperatureProfile, optional) – Temperature model, default is an Isothermal profile at 1500 K

• chemistry (Chemistry, optional) – Chemistry model, default is TaurexChemistry with H2O and CH4

• nlayers (int, optional) – Number of layers. Used if pressure_profile is not defined.

• atm_min_pressure (float, optional) – Pressure at TOA. Used if pressure_profile is not defined.

• atm_max_pressure (float, optional) – Pressure at BOA. Used if pressure_profile is not defined.

• ngauss (int, optional) – Number of gaussian quadrature points, default = 4

compute_final_flux(f_total)

evaluate_emission(wngrid, return_contrib)

evaluate_emission_ktables(wngrid, return_contrib)

classmethod input_keywords()

property logBolometricFlux

partial_model(wngrid=None, cutoff_grid=True)

path_integral(wngrid, return_contrib)

set_num_gauss(value, coeffs=None)

set_quadratures(mu, weight, coeffs=None)

property usingKTables

write(output)

contribute_ktau_emission

Direct Image

class DirectImageModel(planet=None, star=None, pressure_profile=None, temperature_profile=None, chemistry=None, nlayers=100, atm_min_pressure=0.0001, atm_max_pressure=1000000.0, ngauss=4)

Bases: taurex.model.emission.EmissionModel

A forward model for direct imaging of exo-planets

Parameters

• planet (Planet, optional) – Planet model, default planet is Jupiter

• star (Star, optional) – Star model, default star is Sun-like

• pressure_profile (PressureProfile, optional) – Pressure model, alternative is to set nlayers, atm_min_pressure and atm_max_pressure

• temperature_profile (TemperatureProfile, optional) – Temperature model, default is an Isothermal profile at 1500 K

• chemistry (Chemistry, optional) – Chemistry model, default is TaurexChemistry with H2O and CH4

• nlayers (int, optional) – Number of layers. Used if pressure_profile is not defined.

• atm_min_pressure (float, optional) – Pressure at TOA. Used if pressure_profile is not defined.

• atm_max_pressure (float, optional) – Pressure at BOA. Used if pressure_profile is not defined.

• ngauss (int, optional) – Number of gaussian quadrature points, default = 4

compute_final_flux(f_total)

classmethod input_keywords()