pynrc.nb_funcs.plot_contrasts

pynrc.nb_funcs.plot_contrasts(curves, nsig, wfe_list, obs=None, sat_rad=None, ax=None, colors=None, xr=[0, 10], yr=[25, 5], units=None, set_ylog=None, ytwin=True, return_axes=False)[source]

Plot contrast curves

Plot a series of 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.

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

  • units (str) – Units for sensitivity limits. Default is ‘vegamag’. Any other unit requires obs to be set to perform conversion.

  • set_ylog (bool) – Set y-axis to log scale? Default is False for magnitudes and True for all others.

  • ytwin (bool) – Plot opposing y-axes in contrast units. Requires obs to be set.

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

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

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