lightkurve.LightCurve.plot_river

LightCurve.plot_river(period, epoch_time=None, ax=None, bin_points=1, minimum_phase=- 0.5, maximum_phase=0.5, method='mean', **kwargs) matplotlib.axes._axes.Axes[source]

Plot the light curve as a river plot.

A river plot uses colors to represent the light curve values in chronological order, relative to the period of an interesting signal. Each row in the plot represents a full period cycle, and each column represents a fixed phase. This type of plot is often used to visualize Transit Timing Variations (TTVs) in the light curves of exoplanets, but it can be used to visualize periodic signals of any origin.

All extra keywords supplied are passed on to Matplotlib’s pcolormesh function.

Parameters
axAxes

The matplotlib axes object.

period: float

Period at which to fold the light curve

epoch_timefloat

Phase mid point for plotting. Defaults to the first time value.

bin_pointsint

How many points should be in each bin.

minimum_phasefloat

The minimum phase to plot.

maximum_phasefloat

The maximum phase to plot.

methodstr

The river method. Choose from 'mean' or 'median' or 'sigma'. If 'mean' or 'median', the plot will display the average value in each bin. If 'sigma', the plot will display the average in the bin divided by the error in each bin, in order to show the data in terms of standard deviation.

kwargsdict

Dictionary of arguments to be passed on to Matplotlib’s pcolormesh function.

Returns
axAxes

The matplotlib axes object.