neat.NET.plotDendrogram

NET.plotDendrogram(ax, plotargs={}, labelargs={}, textargs={}, incolors={}, inlabels={}, nodelabels={}, cs_comp={}, cmap=None, z_max=None, add_scalebar=True)[source]

Generate a dendrogram of the NET

Parameters

  • ax (matplotlib.axes) – the axes object in which the plot will be made

  • plotargs (dict (string : value)) – keyword args for the matplotlib plot function, specifies the line properties of the dendrogram

  • labelargs (dict (string : value)) – keyword args for the matplotlib plot function, specifies the marker properties for the node points. Or dict with keys node indices, and with values dicts with keyword args for the matplotlib function that specify the marker properties for specific node points. The entry under key -1 specifies the properties for all nodes not explicitly in the keys.

  • textargs (dict (string : value)) – keyword args for matplotlib textproperties

  • incolors (dict (int : string)) – dict with locinds as keys and colors as values

  • inlabels (dict (int : string)) – dict with locinds as keys and label strings as values

  • nodelabels (dict (int: string) or None) – labels of the nodes. If None, nodes are named by default according to their location indices. If empty dict, no labels are added.

  • cs_comp (dict (int : float)) – dict with node inds as keys and compartment colors as values

  • z_max (float or None) – specifies the y-scale. If None, the scale is computed from self

  • add_scalebar (bool) – whether or not to add a scale bar