braincell.vis.compare_values

braincell.vis.compare_values(morpho, value_arrays, *, titles=None, cmap=None, vmin=None, vmax=None, value_label=None, layout=None, shape=None, figsize=None, min_branch_angle_deg=25.0, root_layout='type_split', layout_config=None)

Render the same morphology with multiple value overlays.

Useful for before/after visualisations: compare_values(cell, [v_baseline, v_after_stim]) produces two panels sharing morphology geometry with independent colour scales. When vmin / vmax are explicit they are applied to every panel for a shared range; otherwise each panel auto-scales and receives its own colourbar.

Parameters:

• morpho (Any) – Shared morphology for every panel.

• value_arrays (Sequence[ndarray]) – One scalar array per panel. Each array is interpreted through the normal ValueSpec machinery — per-branch, per-segment, or per-centerline-point.

• titles (Sequence[str] | None) – Optional panel titles.

• cmap (str | None) – Forwarded to plot2d().

• vmin (float | None) – Forwarded to plot2d().

• vmax (float | None) – Forwarded to plot2d().

• value_label (str | None) – Forwarded to plot2d().

• layout (str | None) – Forwarded to plot2d().

• shape (str | None) – Forwarded to plot2d().

• min_branch_angle_deg (float | None) – Forwarded to plot2d().

• root_layout (str) – Forwarded to plot2d().

• layout_config (LayoutConfig | None) – Forwarded to plot2d().

• figsize (tuple[float, float] | None) – Figure size. Defaults to (4.5 * n_panels, 4.5).

Returns:

figure, axes – The composed figure and per-panel axes.

Return type:

tuple[object, tuple[object, ...]]

Raises:

ValueError – If value_arrays is empty.