API Documentation

API

thejoker Package

Functions

plot_rv_curves(samples[, t_grid, rv_unit, ...])	Plot radial velocity curves for the input set of orbital parameter samples over the input grid of times.
plot_phase_fold(sample[, data, ax, ...])	Plot phase-folded radial velocity curves for the input orbital parameter sample, optionally with data phase-folded to the same period.
MAP_sample(samples[, return_index])	Return the maximum a posteriori sample.
is_P_unimodal(samples, data)	Check whether the samples returned are within one period mode.
is_P_Kmodal(samples, data[, n_clusters])	Experimental!
max_phase_gap(sample, data)	Based on the MPG statistic defined here: https://gea.esac.esa.int/archive/documentation/GDR2/Data_analysis/chap_cu7var/sssec_cu7var_validation_sos_sl/ssec_cu7var_sos_sl_qa.html
phase_coverage(sample, data[, n_bins])	Based on the PC statistic defined here: https://gea.esac.esa.int/archive/documentation/GDR2/Data_analysis/chap_cu7var/sssec_cu7var_validation_sos_sl/ssec_cu7var_sos_sl_qa.html
periods_spanned(sample, data)	Compute the number of periods spanned by the data
phase_coverage_per_period(sample, data)	The maximum number of data points within a period.

Classes

TheJoker(prior[, pool, rng, tempfile_path])	A custom Monte-Carlo sampler for two-body systems.
RVData(t, rv, rv_err[, t_ref, clean])	Time-domain radial velocity measurements for a single target.
JokerSamples([samples, t_ref, n_offsets, ...])
JokerPrior([pars, poly_trend, v0_offsets, model])