pynrc.nb_funcs.plot_contrasts_mjup

pynrc.nb_funcs.plot_contrasts_mjup(curves, nsig, wfe_list, obs=None, sat_rad=None, age=100, ax=None, colors=None, xr=[0, 10], yr=None, file=None, linder_models=True, twin_ax=False, return_axes=False, **kwargs)[source]

Plot mass contrast curves

Plot a series of mass contrast curves for corresponding WFE drifts.

Parameters

  • curves (list) – A list with length corresponding to wfe_list. Each list element has three arrays in a tuple: the radius in arcsec, n-sigma contrast, and n-sigma sensitivity limit (vega mag).

  • nsig (float) – N-sigma limit corresponding to sensitivities/contrasts.

  • wfe_list (array-like) – List of WFE drift values corresponding to each set of sensitivities in curves argument.

Keyword Arguments

  • obs (obs_hci) – Corresponding observation class that created the contrast curves. Uses distances and stellar magnitude to plot contrast and AU distances on opposing axes. Also necessary for mjup=True.

  • sat_rad (float) – Saturation radius in arcsec. If >0, then that part of the contrast curve is excluded from the plot

  • age (float) – Required for plotting limiting planet masses.

  • file (string) – Location and name of COND or Linder isochrone file.

  • ax (matplotlib.axes) – Axes on which to plot curves.

  • colors (None, array-like) – List of colors for contrast curves. Default is gradient of blues.

  • twin_ax (bool) – Plot opposing axes in alternate units.

  • return_axes (bool) – Return the matplotlib axes to continue plotting. If obs is set, then this returns three sets of axes.