_DendrogramSection

class visualize.dendrogram._DendrogramSection(name, x_dist_start, x_dist_end, sec, main_bifurcation=False, sec_id=None)

A class to represent a dendrogram section.

A dendrogram section is a single neuron section, as it is represented in a dendrogram. It does not necessarily contain any morphological information. The usecase of this class is to be a leightweight dataclass, used in the Dendrogram and DendrogramStatistics classes.

Parameters:
name : str

The name of the section.

x_dist_start : float

The starting distance of the section in \(\mu m\).

x_dist_end : float

The ending distance of the section in \(\mu m\).

sec : PySection

The neuron section.

main_bifurcation : bool

Whether the section is the main bifurcation. Default is False.

sec_id : int

The section id of the section.

Attributes:
name

The name of the section.

Type:

str

x_dist_start

The starting distance of the section in \(\mu m\).

Type:

float

x_dist_end

The ending distance of the section in \(\mu m\).

Type:

float

sec

The neuron section.

Type:

PySection

synapses

A dictionary of synapses in the section.

Type:

dict

main_bifurcation

Whether the section is the main bifurcation. Default is False.

Type:

bool

sec_id

The section id of the section.

Type:

int

Methods:

_add_synapse(label, x)

Add a synapse to a dendrogram section.