CONAN._classes.load_lightcurves.get_decorr#
- CONAN._classes.load_lightcurves.get_decorr(T_0=None, Period=None, rho_star=None, Duration=None, D_occ=0, Impact_para=0, RpRs=1e-05, Eccentricity=None, omega=None, sesinw=None, secosw=None, Fn=None, ph_off=None, A_ev=0, f1_ev=0, A_db=0, K=0, q1=0, q2=0, cont=0.0, fit_offset=None, mask=False, ss_exp=None, Rstar=None, ttv=False, delta_BIC=-5, decorr_bound=(-10, 10), exclude_cols=[], enforce_pars=[], exclude_pars=[], show_steps=False, plot_model=True, use_jitter_est=False, setup_baseline=True, setup_planet=False, pc_model='cosine', custom_LCfunc=None, verbose=True)#
Function to obtain best decorrelation parameters for each light-curve file using the forward selection method. It compares a model with only an offset to a polynomial model constructed with the other columns of the data. It uses columns 0,3,4,5,6,7,8 to construct the polynomial trend model. The temporary decorr parameters are labelled Ai,Bi for 1st & 2nd order coefficients in column i. if a spline, sinusoid or gp has been setup for the LC object, it is varied also during the decorrelation process.
Decorrelation parameters that reduce the BIC by 5(i.e delta_BIC = -5) are iteratively selected. This implies bayes_factor=exp(-0.5*-5) = 12 or more is required for a parameter to be selected.The result can then be used to populate the
.lc_baseline()method, if use_result is set to True. The transit, limb darkening and phase curve parameters can also be setup from the inputs to this function.- Parameters:
T_0 (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].Period (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].rho_star/Duration (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].D_occ (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].Impact_para (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].RpRs (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].Eccentricity/sesinw (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].omega/secosw (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].Fn (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].ph_off (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].A_ev (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].f1_ev (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].A_db (floats,tuple, None;) – transit/eclipse parameters of the planet.
T_0andPeriodmust be in same units as the time axis (col0) in the data file.D_occ,Fn,A_evandA_dbare in ppm. if float/int, the values are held fixed. tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max].q1 (float,tuple, list (optional);) – Kipping quadratic limb darkening parameters. if float, the values are held fixed. if tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max]. Give list of values to assign value to each unique filter in the data, or one value to be used for all filtets. Default is 0 for all filters.
q2 (float,tuple, list (optional);) – Kipping quadratic limb darkening parameters. if float, the values are held fixed. if tuple/list of len 2 implies gaussian prior as (mean,std) while len 3 implies [min,start_val,max]. Give list of values to assign value to each unique filter in the data, or one value to be used for all filtets. Default is 0 for all filters.
cont (float,list (optional);) – contamination factor of the lightcurve. must be float or list of floats as it does not vary in this least-squares fit. if list, must contain float for each filter. If tuple (norm or uni) is given, the start value is extracted. Default is 0 for all filters.
delta_BIC (float (negative);) – BIC improvement a parameter needs to provide in order to be considered relevant for decorrelation. Default is conservative and set to -5 i.e, parameters needs to lower the BIC by 5 to be included as decorrelation parameter.
fit_offset ('y'/'n' str or None;) – whether to fit an offset for each LC data. if None, preset values are used. e.g adding spline for an lc automatically sets fit_offset=”n” for that lc.
mask (bool ;) – If True, transits and eclipses are masked using T_0, P and rho_star (or duration).
decorr_bound (tuple of size 2;) – bounds when fitting decorrelation parameters. Default is (-1,1)
ss_exp (list, None;) – exposure time of the lcs to configure supersampling. Default is None which implies no supersampling.
Rstar (float, None;) – Stellar radius in solar radii, required for performing light travel time correction. Default is None
ttv (Bool, optional;) – whether to fit a different transit time for each lc file.
exclude_cols (list of int;) – list of column numbers (e.g. [3,4]) to exclude from decorrelation. Default is []. Can also specify “all” to only fit an offset
exclude_pars (list of str;) – list of decorr parameters (e.g. [‘B3’, ‘A5’]) to exclude from decorrelation. Default is [].
enforce_pars (list of int;) – list of decorr params (e.g. [‘B3’, ‘A5’]) to enforce in decorrelation. Default is [].
show_steps (Bool, optional;) – Whether to show the steps of the forward selection of decorr parameters. Default is False
plot_model (Bool, optional;) – Whether to overplot suggested trend model on the data. Defaults to True.
use_jitter_est (Bool, optional;) – Whether to use the estimated jitter from the data in the decorrelation model. Defaults to False.
setup_baseline (Bool, optional;) – whether to use result to setup the baseline model and transit/eclipse models. Default is True.
setup_planet (Bool, optional;) – whether to use input to setup the transit model(planet_parameters/phasecurve/LD functions). Default is False.
pc_model (list, list of str, optional;) – phase curve model to use. Default is “cosine”. Can be one of [“cosine”, “lambert”]. give list of length equal to number of lightcurves to define model for each lightcurve
custom_LCfunc (object, optional;) – namespace object created from lc_obj.add_custom_LC_function(). It contains a custom function with a parameter dictionary and an operation function defining how to combine the output with the LC model. It can also specify if the custom function replaces the native CONAN LC model.
verbose (Bool, optional;) – Whether to show the table of baseline model obtained. Defaults to True.
- Returns:
decorr_result – list containing result object for each lc.
- Return type:
list of result object
- _tmodel#
list of SimpleNamespace objects containing result from leastsquares fit.
- Type:
list;
- _decorr_result#
list of parameter result from leastsquares fit.
- _tra_occ_pars#
list of transit and occultation parameters.