CONAN.misc._param_obj.from_tuple

CONAN.misc._param_obj.from_tuple#

classmethod CONAN.misc._param_obj.from_tuple(param_in, step=None, lo=None, hi=None, user_input=None, user_data=None, prior_str=None, func_call='')#

alternative method to initialize _param_obj using from a tuple. * if int/float is given Returns (to_fit=”n”,start_value=param_in,step_size=0,prior=”n”,prior_mean=param_in,prior_width_lo=0,prior_width_hi=0,bounds_lo=0,bounds_hi=0,user_input=None) * if tuple of len 2 it Returns (to_fit=”y”,start_value=param_in[0],step_size=0.1*param_in[1],prior=”p”,prior_mean=param_in[0],prior_width_lo=param_in[1],prior_width_hi=param_in[1],bounds_lo=param_in[0]-10*param_in[1],bounds_hi=param_in[0]+10*param_in[1],user_input=None) * if tuple of len 3 it Returns (to_fit=”y”,start_value=param_in[0],step_size=0.001*np.ptp(param_in),prior=”n”,prior_mean=param_in[0],prior_width_lo=0,prior_width_hi=0,bounds_lo=param_in[0],bounds_hi=param_in[2],user_input=None) * if tuple of len 4 it Returns (to_fit=”y”,start_value=param_in[2],step_size=0.1*param_in[3],prior=”p”,prior_mean=param_in[2],prior_width_lo=param_in[3],prior_width_hi=param_in[3],bounds_lo=param_in[0],bounds_hi=param_in[1],user_input=None)

Parameters:

  • param_in (int, float,tuple,None;) – input float/tuple with the parameters for the object.

  • step (float,None;) – step size for the parameter to override the default value derived from param

  • lo (float,None;) – lower bound for the parameter to override the default value derived from param_in

  • hi (float;) – upper bound for the parameter to override the default value derived from param_in

  • tuple (user_input;) – stores prior input given by the user

  • int – stores prior input given by the user

  • float – stores prior input given by the user

  • user_data (any;) – any data to be stored in the parameter object.

  • func_call (str;) – name of the function calling this method, to be used in error messages.

Returns:

param_obj – object with the parameters.

Return type:

object;

Example

>>> RpRs = (0.1,0.002)
>>> param_obj = _param_obj.from_tuple(RpRs,func_call="planet_parameters():")
Contents