Skip to content

Total Cell Count

compute_total_cell_count(cellularity, carrying_capacity)

Computes the total cell count in a given cellularity map.

The total cell count is calculated as the sum of the cellularity values across the map, scaled by the voxel carrying capacity.

Parameters:

Name Type Description Default
cellularity Image3D | ndarray | Tensor

The cellularity map, which can be an Image3D instance, a Numpy array, or a PyTorch tensor.

required
carrying_capacity float

The carrying capacity of a voxel.

required

Returns:

Type Description
float | Tensor

float | torch.Tensor: The total cell count. If the input cellularity is a PyTorch tensor, the result will also be a tensor.

Raises:

Type Description
ValueError

If the input cellularity is of an unsupported type.