neurom.view.view.soma

neurom.view.view.soma(sm, plane='xy', new_fig=True, subplot=False, **kwargs)

Generates a 2d figure of the soma.

Parameters:

• soma – Soma neurom.Soma object
• plane – str Accepted values: Any pair of of xyz Default value is ‘xy’.treecolor
• 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 soma. Soma: 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.
• limits – list or boolean List of type: [[xmin, ymin, zmin], [xmax, ymax, zmax]] If False the figure will not be scaled. If True the figure will be scaled according to tree limits. Default value is False.

Returns:

A 2D matplotlib figure with a soma view, at the selected plane.