CONAN.utils.ecc_om_par

CONAN.utils.ecc_om_par#

CONAN.utils.ecc_om_par(ecc, omega, conv_2_obj=False, return_tuple=False)#

This function calculates the prior values and limits for the eccentricity and omega parameters, sesinw and secosw. It also converts the input values given as tuples to a SimpleNamespace object

Parameters:

  • ecc (float, tuple, SimpleNamespace;) – eccentricity value or tuple of (mean, width) or SimpleNamespace object with the following Attributes to_fit: str; “y” if to be fit, “n” if not to be fit start_value: float; starting value step_size: float; step size for the MCMC prior: str; “p” if normal prior is set, “n” if not prior_mean: float; prior mean prior_width_lo: float; lower width of the prior prior_width_hi: float; upper width of the prior bounds_lo: float; lower bound bounds_hi: float; upper bound

  • omega (float, tuple, SimpleNamespace;) – argument of periastron value (in radians) or tuple of (mean, width) or SimpleNamespace object with the same attributes as ecc

  • conv_2_obj (bool;) – If True, convert the input values (int/float/tuple) to a SimpleNamespace object with attributes like ecc. Default is False.

  • return_tuple (bool;) – If True, return the values as a int/float or tuple of length 2/3 . Default is False.

Contents