CONAN._classes.load_rvs

CONAN._classes.load_rvs#

class CONAN._classes.load_rvs(file_list=None, data_filepath=None, input_rv=None, nplanet=1, rv_unit='km/s', lc_obj=None, sort=False, verbose=True, show_guide=False)#

rv object to hold lightcurves for analysis

Parameters:

  • data_filepath (str;) – filepath where rvs files are located

  • file_list (list;) – list of filenames for the rvs

  • input_rv (dict;) – dictionary of input RV data. If provided, it overrides the file_list and data_filepath parameters. Each key is the name of the lightcurve and the value is a numpy array with the lightcurve data. The array must be of shape (N,M) where N is the number of data points and M is the number of columns (>=3).

  • nplanet (int;) – number of planets in the system. Default is 1.

  • rv_unit (str;) – unit of the rv data. Must be one of [“m/s”,”km/s”]. Default is “km/s”.

  • lc_obj (object;) – lightcurve object to link the parameters with the rv object. if None, it uses the already defined light curve object or creates a new empty one.

  • sort (bool;) – if True, sorts the rvs based on the median time. Default is False.

  • show_guide (bool;) – print output to guide the user. Default is False.

_obj_type#

object type

Type:

str;

_fpath#

path to the data files

Type:

str;

_names#

list of names of the input files

Type:

list;

_input_rv#

dictionary to hold the input rv data arrays. Keys of the dictionary should be the name for each file containing a 2D numpy array (n_pts X n_col).

Type:

dict;

_RVunit#

unit of the rv data

Type:

str;

_nRV#

number of input rv files

Type:

int;

_lcobj#

lightcurve object linked to the rv object

Type:

object;

_rms_estimate#

list of rms estimates for each rv data

Type:

list;

_jitt_estimate#

list of jitter estimates for each rv data

Type:

list;

_RVbases_init#

list of initial baseline model coefficients for each rv

Type:

list;

Returns:

rv_obj

Return type:

rv object

Examples

>>> rv_obj = load_rvs(file_list=["rv1.dat","rv2.dat"], data_filepath="/path/to/data/", rv_unit="km/s")
_RVbases_init#
_RVunit = 'km/s'#
_fpath#
_input_rv#
_lcobj = None#
_nRV#
_nplanet = 1#
_obj_type = 'rv_obj'#
_rescaled_data#

Methods#

add_custom_RV_function([func, x, func_args, ...])

Define custom model to be combined with or to replace the RV model. This must be given as a

add_rvGP([rv_list, par, kernel, operation, amplitude, ...])

Define GP hyperparameters for each RV. The first hyperparameter h1 is amplitude (standard deviation)

add_spline([rv_list, par, degree, knot_spacing, ...])

add spline to fit correlation along 1 or 2 columns of the data. This splits the data at

get_decorr([T_0, Period, K, Eccentricity, omega, ...])

Function to obtain best decorrelation parameters for each rv file using the forward

planet_parameters([T_0, Period, Eccentricity, omega, ...])

Define parameters and priors of RV model. By default, the parameters are fixed to the given values.

plot([plot_cols, col_labels, nrow_ncols, figsize, ...])

visualize data

print([section])

Print out all input configuration (or particular section) for the RV object.

rescale_data_columns([method, columns, verbose])

Function to rescale the data columns of the RVs. This can be important when decorrelating

rv_baseline([dcol0, dcol3, dcol4, dcol5, sinPs, ...])

Define rv baseline model parameters to fit.

save_RVs([save_path, overwrite, verbose])

Save the loaded rvs to file.

update_planet_parameters([T_0, Period, Eccentricity, ...])

Update the rv planet parameters defined in the lightcurve object.
Contents