neurom.view.view.soma3d

neurom.view.view.soma3d(sm, new_fig=True, new_axes=True, subplot=False, **kwargs)

Generates a 3d figure of the soma.

Parameters:
  • soma – Soma neurom.Soma object
  • 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.
Returns:

A 3D matplotlib figure with a soma view.