neurom.view.view.dendrogram

neurom.view.view.dendrogram(obj, show_diameters=True, new_fig=True, new_axes=True, subplot=False, **kwargs)

Generates a figure of the neuron, that contains a soma and a list of trees.

Parameters:

• obj – Neuron or tree neurom.Neuron, neurom.Tree
• show_diameters – boolean Determines if node diameters will be show or not.
• linewidth – float Defines the linewidth of the tree, if diameter is set to False. Default value is 1.2.
• alpha – float Defines throughe transparency of the tree. 0.0 transparent through 1.0 opaque. Default value is 0.8.
• treecolor – str or None Defines the color of the tree. If None the default values will be used, depending on the type of tree: Basal dendrite: “red” Axon : “blue” Apical dendrite: “purple” Undefined tree: “black” Default value is None.
• new_fig – boolean Defines if the tree will be plotted in the current figure (False) or in a new figure (True) Default value is True.
• subplot – matplotlib subplot value or False If False the default subplot 111 will be used. For any other value a matplotlib subplot will be generated. Default value is False.

Returns:

A 2D matplotlib figure with a dendrogram view.