stnmf.plot.getcolors

stnmf.plot.getcolors(colors, num, key='color')

Turn an arbitrary description of colors into a cycler

Parameters:
  • colors (color, str, iterable, or matplotlib.colors.Colormap) – Single color or iterable (list, tuple, array_like) of colors in any representation, or color map. If str, registered colormaps will be searched in matplotlib, otherwise it is assumed a named color or if ‘auto’ the default color cycle is used

  • num (int) – Number of colors requested. Colors will repeat after that number

  • key (str) – Specify the key of the prop cycle. Default is ‘color’

Returns:

cycler (cycler.Cycler) – Color cycler with the key word specified with key