single_cell_parser ❭ cell_modify_functions ❭ scale_apical ❭ scale_apical

scale_apical¶

single_cell_parser.cell_modify_functions.scale_apical.scale_apical(cell, scale=None, compartment='ApicalDendrite')¶

Scale the apical dendrite of a cell.

Parameters:¶

• cell (Cell) – The cell to scale.

• scale (float) – The scaling factor.

• compartment (str) – The compartment to scale. If “ApicalDendrite”, the cell is assumed to have sections with label “ApicalDendrite”. If “Trunk”, the cell is assumed to have detailed\_labels assigned manually, or by biophysics_fitting.utils.augment_cell_with_detailed_labels(). Currently, only “ApicalDendrite” and “Trunk” are supported compartments.

Returns:¶

The scaled cell.

Return type:¶

Cell

Raises:¶

ValueError – If the compartment is not “ApicalDendrite” or “Trunk”.