Dendrite#

class dendrify.compartment.Dendrite(name, model='passive', **kwargs)[source]#

Bases: Compartment

A class that automatically generates and handles all differential equations and parameters needed to describe a dendritic compartment, its active mechanisms, and any currents (synaptic, dendritic, ionic, noise) passing through it.

See also

Dendrite inherits all the methods and attributes of its parent class Compartment. For a complete list, please refer to the documentation of the latter.

Parameters:
  • name (str) – A unique name used to tag compartment-specific equations and parameters. It is also used to distinguish the various compartments belonging to the same NeuronModel.

  • model (str, optional) – A keyword for accessing Dendrify’s library models. Dendritic compartments are by default set to 'passive'.

Methods:

dspikes

Adds the mechanisms and parameters needed for dendritic spiking.

Attributes:

event_actions

A string that is used to tell Brian how to handle the dSpike events.

events

A dictionary of all dSpike events created for a single dendrite.

dspikes(channel, threshold=None, g_rise=None, g_fall=None)[source]#

Adds the mechanisms and parameters needed for dendritic spiking. Under the hood, this method creates all equations, conditions and actions to utilize Brian’s custom events functionality. Spikes are generated through the sequential activation of a positive (sodium or calcium-like) and a negative current (potassium-like current) when a specified dSpike threshold is crossed.

Hint

The dendritic spiking mechanism as implemented here has three distinct phases.

INACTIVE PHASE:

When the dendritic voltage is subthreshold OR the simulation step is within the refractory period. dSpikes cannot be generated during this phase.

DEPOLARIZATION PHASE:

When the dendritic voltage crosses the dSpike threshold AND the refractory period has elapsed. This triggers the instant activation of a positive current that enters the dendrite and then decays exponentially.

REPOLARIZATION PHASE:

This phase starts automatically after a specified delay from the initiation of the dSpike. A negative current is activated instantly and then decays exponentially. Also a new refractory period begins.

Parameters:
  • channel (str) – Ion channel type. Available options: 'Na', 'Ca' (coming soon).

  • threshold (Quantity) – The membrane voltage threshold for dendritic spiking, by default None.

  • g_rise (Quantity) – The conductance of the current that is activated during the depolarization phase, by default None.

  • g_fall (Quantity) – The conductance of the current that is activated during the repolarization phase, by default None.

property event_actions#

A string that is used to tell Brian how to handle the dSpike events.

Returns:

Executable code that runs automatically in the background.

Return type:

str

property events#

A dictionary of all dSpike events created for a single dendrite.

Returns:

Keys: event names, values: events conditions.

Return type:

dict