Orbital Parameter Basis Sets

class radvel.basis.Basis(*args: str | int)

Object that knows how to convert between the various Keplerian bases

Parameters:

• name (str) – basis name

• num_planets (int) – number of planets

synth_params

name of synth basis

Type:

str

Note

Valid basis functions:

‘per tp e w k’ (The synthesis basis)

‘per tc secosw sesinw logk’

‘per tc secosw sesinw k’

‘per tc ecosw esinw k’

‘per tc e w k’

‘logper tc secosw sesinw k’

‘logper tc secosw sesinw logk’

‘per tc se w k’

from_synth(params_in: radvel.model.Parameters | pd.DataFrame, newbasis: str, **kwargs: bool) → radvel.model.Parameters | pd.DataFrame

Convert from synth basis into another basis

Convert instance of Parameters with parameters of a given basis into the synth basis

Parameters:

• params_in (radvel.Parameters or pandas.DataFrame) – radvel.Parameters object or pandas.Dataframe containing orbital parameters expressed in current basis

• newbasis (string) – string corresponding to basis to switch into

• keep (bool [optional]) – keep the parameters expressed in the old basis, else remove them from the output dictionary/DataFrame

Returns:

dict or dataframe with the parameters converted into the new basis

get_circparams() → list[str]

Return the 3 parameters for a circular orbit of a plent in the object’s basis

Returns:

the params for a circular orbit

get_eparams() → list[str]

Return the eccentricity parameters for the object’s basis

Returns:

the params which have to do with eccentricity

to_any_basis(params_in: Parameters, newbasis: str) → Parameters

Convenience function for converting Parameters object to an arbitraty basis

Parameters:

• params_in (Parameters) – Parameters object expressed in current basis

• newbasis (string) – string corresponding to basis to switch into

Returns:

Parameters object expressed in the new basis

to_synth(params_in: Parameters, **kwargs: bool | str) → Parameters

Convert to synth basis Convert Parameters object with parameters of a given basis into the synth basis :param params_in: Parameters object or pandas.Dataframe containing

orbital parameters expressed in current basis

Parameters:

noVary (bool [optional]) – if True, set the ‘vary’ attribute of the returned Parameter objects to ‘’ (used for displaying best fit parameters)

Returns:

parameters expressed in the synth basis

Return type:

Parameters or DataFrame