antaress.ANTARESS_analysis.ANTARESS_ana_comm module

par_formatting_inst_vis(p_start, fixed_args, inst, vis, line_type)

Parameter formatting: instrument, visit, degree

Defines complementary information for parameters with instrument, visit, and/or degree dependence

Parameters:

TBD

Returns:

TBD

prior_check(par, priors_par, params, args)

Prior check

Checks that priors are physically valid.

Parameters:

TBD

Returns:

None

MCMC_walkers_check(par, fit_dic, params, args)

MCMC walkers check

Checks that walkers initialization range is valid.

Parameters:

• par (str) – Parameter to check.

• fit_dic (dict) – Dictionary containing fitting information.

• params (dict) – Parameter values.

• args (dict) – Additional arguments.

Returns:

None

model_par_names(par)

Naming function

Returns name and unit of input variable for plot display.

Parameters:

None

Returns:

name_par (str) – parameter name

Example

>>> model_par_names(x)
x_name

model_par_units(par)

Unit function

Returns plain text unit of input variable.

Parameters:

None

Returns:

unit_par (str) – parameter unit

Example

>>> model_par_units(x)
x_name

init_joined_routines(rout_mode, gen_dic, system_param, theo_dic, data_dic, fit_prop_dic)

Joined fits: general initialization.

Initializes properties for the joined fits to stellar and planetary lines and properties.

Parameters:

TBD

Returns:

TBD

init_joined_routines_inst(inst, fit_dic, fixed_args)

Joined fits: instrument initialization.

Initializes properties for the joined fits to stellar and planetary lines.

Parameters:

• inst (str) – Instrument considered.

• fit_prop_dic (dict) – Dictionary containing the parameters of the fitting process.

• fixed_args (dict) – Dictionary containing the arguments that will be passed to the fitting function.

Returns:

None

init_joined_routines_vis(inst, vis, fit_dic, fixed_args)

Joined fits: visit initialization.

Initializes properties for the joined fits to stellar and planetary lines.

Parameters:

• inst (str) – Instrument considered.

• vis (str) – Visit considered.

• fit_dic (dict) – Dictionary containing the parameters of the fitting process.

• fixed_args (dict) – Dictionary containing the arguments that will be passed to the fitting function.

Returns:

None

init_joined_routines_vis_fit(rout_mode, inst, vis, fit_dic, fixed_args, data_vis, gen_dic, data_dic, coord_dic, theo_dic, data_prop, plot_dic)

Joined fits: initialization.

Initializes properties for the joined fits to stellar and planetary lines.

Parameters:

TBD

Returns:

TBD

com_joint_fits(rout_mode, fit_dic, fixed_args, gen_dic, data_dic, theo_dic, mod_prop)

Wrap-up for time-series fits.

Performs joint fits to time-series.

Parameters:

TBD

Returns:

TBD

MAIN_single_anaprof(vis_mode, data_type, data_dic, gen_dic, inst, vis, coord_dic, theo_dic, plot_dic, star_param)

Main analysis routine for single profiles

Initializes and calls analysis of line profiles

• profiles in their input rest frame, original exposures, for all formats

• profiles in their input or star (if aligned) rest frame, original exposures, converted from 2D->1D

• profiles in their input or star (if aligned) rest frame, binned exposures, all formats

• profiles in the star rest frame, binned exposures, all formats

Formats are CCF profiles, 1D spectra, or a specific 2D spectral order. Each profile is analyzed independently from the others. The routine can also be used to fit the unocculted disk-integrated stellar profile using best estimates for the intrinsic stellar profiles (measured, theoretical, imported)

Parameters:

TBD

Returns:

TBD

single_anaprof(isub_exp, iexp, inst, data_dic, vis, fit_prop_dic, gen_dic, verbose, cond_def_fit, cond_def_cont, prof_type, edge_bins, cen_bins, flux_loc, cov_loc, idx_force_det, theo_dic, fit_properties, priors, model_choice, model_prop, data_type)

Single profile analysis routine

Performs fits and measurements of line profiles.

Parameters:

TBD

Returns:

TBD

prior_sini_geom(p_step_loc, fixed_args, prior_func_prop)

Prior: sin(istar)

Calculates \(\log(p)\) for stellar inclination \(i_\star\).

Assumes isotropic distribution of stellar orientations (equivalent to draw a uniform distribution on \(\cos(i_\star)\)) that favor stellar inclination closer to 90:math:^circ

\[\begin{split}&p(x) = \sin(i_\star(x))/2 \\ &\ln(p(x)) = \ln(0.5 \sin(i_\star(x)))\end{split}\]

Where p is normalized by the integral of \(\sin(i_\star)\) over the definition space of \(i_\star\) (0:180:math:^circ), which is 2.

Parameters:

TBD

Returns:

TBD

prior_cosi(p_step_loc, fixed_args, prior_func_prop)

Prior: cos(ip)

Calculates \(\log(p)\) for orbital inclination \(i_p\).

Prior imposes that \(0<i_p<90`^\circ\)

Parameters:

TBD

Returns:

TBD

prior_sini(p_step_loc, fixed_args, prior_func_prop)

Prior: sin(ip)

Calculates \(\log(p)\) for orbital inclination \(i_p\).

Imposes Gaussian prior on \(\sin(i_p)\).

Parameters:

TBD

Returns:

TBD

prior_b(p_step_loc, fixed_args, prior_func_prop)

Prior: b

Calculates \(\log(p)\) for impact parameter.

Prior imposes that \(b<1\).

Used when orbital inclination \(i_p\) and/or semi-major axis \(a/R_\star\) are varied. If only \(i_p\) or \(a/R_\star\) is free to vary, the other property should still be defined as a constant parameter for this prior to be used.

Parameters:

TBD

Returns:

TBD

prior_DR(p_step_loc, fixed_args, prior_func_prop)

Prior: DR

Calculates \(\log(p)\) for differential rotation coefficients \(\alpha_\mathrm{rot}\) and \(\beta_\mathrm{rot}\).

If both \(\alpha_\mathrm{rot}\) and \(\beta_\mathrm{rot}\) are used, their sum cannot be larger than 1 if the star rotates in the same direction at all latitudes.

Parameters:

TBD

Returns:

TBD

prior_vsini(p_step_loc, fixed_args, prior_func_prop)

Prior: veq sin(istar)

Calculates \(\log(p)\) for sky-projected stellar rotational velocity \(v_\mathrm{eq} \sin(i_\star)\).

Imposes Gaussian prior on \(v_\mathrm{eq} \sin(i_\star)\). Relevant when \(v_\mathrm{eq}\) and \(i_\star\) are fitted independently, otherwise set a prior on \(v_\mathrm{eq}\) alone.

Parameters:

TBD

Returns:

TBD

prior_vsini_deriv(p_step_loc, fixed_args, prior_func_prop)

Prior: veq sin(istar)

Calculates \(\log(p)\) for sky-projected stellar rotational velocity \(v_\mathrm{eq} \sin(i_\star)\).

Imposes Gaussian prior on \(v_\mathrm{eq} \sin(i_\star)\). Relevant when \(P_\mathrm{eq}\) and \(i_\star\) are fitted independently, otherwise set a prior on \(v_\mathrm{eq}\) alone.

Parameters:

TBD

Returns:

TBD

prior_contrast(p_step_loc, args_in, prior_func_prop)

Prior: intrinsic contrast

Calculates \(\log(p)\) for the contrast \(C_\mathrm{Intr}\) of intrinsic stellar lines.

Prior imposes that \(0<C_\mathrm{Intr}<1\). The contrast of intrinsic (and a fortiori measured) stellar lines should be physical. See details on the calculation of line contrast in joined_intr_prof() (for now assumes a single planet per visit transits).

Parameters:

TBD

Returns:

TBD

prior_FWHM_vsini(p_step_loc, args, prior_func_prop)

Prior: intrinsic FWHM

Calculates \(\log(p)\) for the mathrm{FWHM} \(\mathrm{FWHM}_\mathrm{Intr}\) of intrinsic stellar lines.

Prior imposes that \(\mathrm{FWHM}_\mathrm{Intr}^2 + \mathrm{FWHM}_\mathrm{Inst}^2 + v_\mathrm{eq} \sin(i_\star)^2<\mathrm{FWHM}_\mathrm{DI}\). We assume that the intrinsic line cannot be larger than the disk-integrated one, after rotational broadening. This sets an upper limit on \(\mathrm{FWHM}_\mathrm{Intr}\), considering there can be other broadening contributions See details on the calculation of line contrast in joined_intr_prof() (for now assumes intrinsic line must have constant width).

Parameters:

TBD

Returns:

TBD

com_joint_postproc(p_final, fixed_args, fit_dic, merged_chain, gen_dic)

Wrap-up for post-processing of time-series fits.

Performs joint fits to time-series.

Parameters:

TBD

Returns:

TBD

conv_cosistar(deriv_prop, fixed_args_in, fit_dic_in, p_final_in, merged_chain_in)

Parameter conversion: cos(i_star)

Converts results from \(\chi^2\), mcmc, or ns fitting: from \(\cos(i_\star)\) to \(i_\star\).

Parameters:

TBD

Returns:

TBD

conv_CF_intr_meas(deriv_prop, inst_list, inst_vis_list, fixed_args, merged_chain, gen_dic, p_final, fit_dic)

Parameter conversion: line contrast and FWHM

Converts results from \(\chi^2\), mcmc, or ns fitting: from intrinsic width and contrast to measured-like values.

Parameters:

TBD

Returns:

TBD