SomaToDendrite

Contents

SomaToDendrite#

class braintools.conn.SomaToDendrite(target_dendrites=None, prob_per_dendrite=0.8, **kwargs)#

Specialized connectivity from soma to dendritic compartments.

This creates connections specifically from soma compartments to dendritic compartments, commonly used for modeling antidromic activation or backpropagating action potentials.

Changed in version 0.4.0: Pairs are sampled as in CompartmentSpecific (binomial edge count, then distinct pairs), so the edges for a given seed differ from 0.3.

Parameters:
  • target_dendrites (List[int] | None) – List of dendrite compartment types to target.

  • prob_per_dendrite (float | Dict[int, float]) – Connection probability to each dendrite type.

Examples

Basic soma-to-dendrite connections:

>>> from braintools.conn import SomaToDendrite, BASAL_DENDRITE, APICAL_DENDRITE
>>> soma_dend = SomaToDendrite(
...     target_dendrites=[BASAL_DENDRITE, APICAL_DENDRITE],
...     prob_per_dendrite=0.8,
...     seed=0,
... )
>>> result = soma_dend(pre_size=50, post_size=50)
>>> result.n_connections
3914

Different probabilities for different dendrite types:

>>> soma_dend_specific = SomaToDendrite(
...     target_dendrites=[BASAL_DENDRITE, APICAL_DENDRITE],
...     prob_per_dendrite={
...         BASAL_DENDRITE: 0.9,
...         APICAL_DENDRITE: 0.7
...     }
... )