sidpy.viz.plot_utils.curve.plot_line_family

sidpy.viz.plot_utils.curve.plot_line_family(axis, x_vec, line_family, line_names=None, label_prefix='', label_suffix='', y_offset=0, show_cbar=False, **kwargs)[source]

Plots a family of lines with a sequence of colors

Parameters:

  • axis (matplotlib.axes.Axes object) – Axis to plot the curve

  • x_vec (array-like) – Values to plot against

  • line_family (2D numpy array) – family of curves arranged as [curve_index, features]

  • line_names (array-like) – array of string or numbers that represent the identity of each curve in the family

  • label_prefix (string / unicode) – prefix for the legend (before the index of the curve)

  • label_suffix (string / unicode) – suffix for the legend (after the index of the curve)

  • y_offset ((optional) number) – quantity by which the lines are offset from each other vertically (useful for spectra)

  • show_cbar ((optional) bool) – Whether or not to show a colorbar (instead of a legend)