Ctrl+K

plot_phase_fold

plot_phase_fold#

thejoker.plot_phase_fold(sample, data=None, ax=None, with_time_unit=False, n_phase_samples=4096, add_labels=True, show_s_errorbar=True, residual=False, remove_trend=True, plot_kwargs=None, data_plot_kwargs=None)#

Plot phase-folded radial velocity curves for the input orbital parameter sample, optionally with data phase-folded to the same period.

Parameters:

  • sample (JokerSamples) – One posterior sample from The Joker.

  • data (~thejoker.data.RVData, optional) – Over-plot the data as well.

  • ax (~matplotlib.Axes, optional) – A matplotlib axes object to plot on to. If not specified, will create a new figure and plot on that.

  • with_time_unit (bool, astropy.units.Unit (optional)) – Plot the phase in time units, not on 0–1 scale (i.e., mod P not mod 1).

  • n_phase_samples (int (optional)) – Number of grid points in phase grid.

  • add_labels (bool, optional) – Add labels to the axes or not.

  • show_s_errorbar (bool, optional) – Plot an additional error bar to show the extra uncertainty s value for this sample.

  • residual (bool, optional) – Plot the residual of the data relative to the model.

  • remove_trend (bool, optional) – Remove the long-term velocity trend from the data and model before plotting.

  • plot_kwargs (dict, optional) – Passed to matplotlib.pyplot.plot() for plotting the orbits.

  • data_plot_kwargs (dict, optional) – Passed to thejoker.data.RVData.plot().

Returns:

fig

Return type:

~matplotlib.Figure

Contents