CVContext

Contents

CVContext#

class braincell.mech.CVContext(cv_id, branch_id, branch_name, branch_type, prox, dist, midpoint, length, area, radius_prox, radius_mid, radius_dist, diam_mid, diam_arc_mean, path_distance_to_root, path_distance_from_soma)[source]#

Read-only geometry context for one control volume.

Callable cable and density parameters receive one context per control volume. All physical fields carry brainunit units, while prox, dist, and midpoint are normalized branch coordinates in [0, 1].

Parameters:

  • cv_id (int) – Stable control-volume index.

  • branch_id (int) – Owning morphology branch index.

  • branch_name (str) – Owning morphology branch name.

  • branch_type (str) – Owning morphology branch type.

  • prox (float) – Normalized control-volume bounds and midpoint.

  • dist (float) – Normalized control-volume bounds and midpoint.

  • midpoint (float) – Normalized control-volume bounds and midpoint.

  • length (Quantity) – Control-volume cable length.

  • area (Quantity) – Control-volume lateral membrane area.

  • radius_prox (Quantity) – Radius at the proximal boundary, midpoint, and distal boundary.

  • radius_mid (Quantity) – Radius at the proximal boundary, midpoint, and distal boundary.

  • radius_dist (Quantity) – Radius at the proximal boundary, midpoint, and distal boundary.

  • diam_mid (Quantity) – Diameter at the control-volume midpoint.

  • diam_arc_mean (Quantity) – Arc-length-weighted mean diameter over the control volume.

  • path_distance_to_root (Quantity) – Tree path distance from root-branch coordinate x=0 to the control-volume midpoint.

  • path_distance_from_soma (Quantity) – Tree path distance from the soma surface. Soma control volumes and first-order neurite attachment points use zero as their reference.

Contents