stnmf.plot.outlines

stnmf.plot.outlines(subunits, sta=None, colors='#1b9e77', numbered=True, filled=True, ax=None, **kwargs)

Plot the outlines of the modules

Parameters:

  • subunits ((r,) array_like) – Outlines of r subunits. Each element is an (2, n) array_like containing n coordinate pairs. n may be different for each outline. Outlines may be arbitrary, i.e. either contours or ellipses

  • sta ((n,2) array_like, optional) – Outline of spike-triggered average with n coordinate pairs. Omit to only draw the subunit outlines. Default is None

  • colors (color, iterable, matplotlib.colors.Colormap, optional) – Single color or color sequence for the subunit outlines. If single color, the same color is used for all outlines. If iterable or colormap, colors are iterated over outlines. Default is ‘#1b9e77’

  • numbered (bool, optional) – Number the subunit outlines. Numbering is done in the order of the subunits provided. Default is True

  • filled (bool, opional) – Color fill the subunits outlines. Default is True

  • ax (matplotlib.axes.Axes, optional) – Existing figure axis to draw the outlines into. If None, a new figure is created. Default is None

Notes

There is no error handling in favor of performance