plot¶

visualize.cell_morphology_visualizer.CellMorphologyVisualizer.plot(color='grey', show_legend=True, show_synapses=False, time_point=None, save='', highlight_section=None, highlight_x=None)¶

Plot the cell morphology in 3D.

Can be used to create a static plot of the cell morphology, which may be color-coded with voltage, ion dynamics, or synapse activations.

Parameters:¶

color : str | [[float]]¶

If you want some other color overlayed on the cell morphology. Options: “voltage”, “vm”, “synapses”, “synapse”, or a color string, or a nested list of colors for each section

show_legend : bool¶

whether the voltage legend should appear in the plot

show_synapses : bool | List[str]¶

Whether the synapse activations should be shown If it is a boolean, all synapses will be shown. If it is a list of strings, only those synapses whose type match an entry in the list will be shown

time_point : int|float¶

Time point from which to show the voltage/synapses. If None, no voltage will be shown, and synapses will not be filtered based on activation times. Defaults to None

save : bool¶

path where the plot will be saved. If it’s empty it will not be saved (Default)

highlight_section : int¶

section number of the section that should be highlighted

highlight_x : float¶

x coordinate of the section that should be highlighted

Returns:¶

matplotlib figure containing the plot.

Return type:¶

fig