EphysProperties

class dendrify.ephysproperties.EphysProperties(name=None, length=None, diameter=None, cm=None, gl=None, r_axial=None, v_rest=None, scale_factor=1.0, spine_factor=1.0)

Bases: object

A class for calculating various important electrophysiological properties for a single compartment.

Note

An EphysProperties object is automatically created and linked to a Compartment, Soma, or Dendrite object during the instantiation of the latter.

Parameters:

• name (str, optional) – A compartment’s name, by default None

• length (Quantity, optional) – A compartment’s length, by default None

• diameter (Quantity, optional) – A compartment’s diameter, by default None

• cm (Quantity, optional) – Specific capacitance (usually μF / cm^2), by default None

• gl (Quantity, optional) – Specific leakage conductance (usually μS / cm^2), by default None

• r_axial (Quantity, optional) – Axial resistance (usually Ohm * cm), by default None

• v_rest (Quantity, optional) – Resting membrane voltage, by default None

• scale_factor (float, optional) – A global area scale factor, by default 1.0

• spine_factor (float, optional) – A dendritic area scale factor to account for spines, by default 1.0

Attributes:

area	A compartment's surface area (open cylinder) based on its length and diameter.
capacitance	A compartment's absolute capacitance based on its specific capacitance (cm) and surface area.
g_cylinder	The conductance (of coupling currents) passing through a cylindrical compartment based on its dimensions and its axial resistance.
g_leakage	A compartment's absolute leakage conductance based on its specific leakage conductance (gl) and surface area.
parameters	Returns a dictionary of all electrophysiological parameters.
total_area_factor	The total surface are factor.

Methods:

g_couple

The conductance (of coupling currents) between the centers of two adjacent cylindrical compartments, based on their dimensions and the axial resistance.

property area

A compartment’s surface area (open cylinder) based on its length and diameter.

Returns:

A compartment’s surface area

Return type:

Quantity

property capacitance

A compartment’s absolute capacitance based on its specific capacitance (cm) and surface area.

Return type:

Quantity

static g_couple(comp1, comp2)

The conductance (of coupling currents) between the centers of two adjacent cylindrical compartments, based on their dimensions and the axial resistance.

Parameters:

• comp1 (EphysProperties) – An EphysProperties object

• comp2 (EphysProperties) – An EphysProperties object

Return type:

Quantity

property g_cylinder

The conductance (of coupling currents) passing through a cylindrical compartment based on its dimensions and its axial resistance. To be used when then the total number of compartments is low and the adjacent-to-soma compartments are highly coupled with the soma.

Return type:

Quantity

property g_leakage

A compartment’s absolute leakage conductance based on its specific leakage conductance (gl) and surface area.

Return type:

Quantity

property parameters

Returns a dictionary of all electrophysiological parameters.

Return type:

dict

property total_area_factor

The total surface are factor.

Return type:

float